Microsoft.ManagedNetworkFabric (preview:2024-02-15)

2025/11/05 • 167 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ManagedNetworkFabric/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_ListBySubscription (new)
Description :  Implements AccessControlLists list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/accessControlLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AccessControlList items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGatewayRules_ListBySubscription (new)
Description :  List all Internet Gateway rules in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InternetGatewayRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGateways_ListBySubscription (new)
Description :  Displays Internet Gateways list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/internetGateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InternetGateway items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpCommunities_ListBySubscription (new)
Description :  Implements IP Communities list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipCommunities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IpCommunity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpExtendedCommunities_ListBySubscription (new)
Description :  Implements IpExtendedCommunities list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IpExtendedCommunity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpPrefixes_ListBySubscription (new)
Description :  Implements IpPrefixes list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IpPrefix items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_ListBySubscription (new)
Description :  Displays L2IsolationDomains list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The L2IsolationDomain items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_ListBySubscription (new)
Description :  Displays L3IsolationDomains list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The L3IsolationDomain items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeighborGroups_ListBySubscription (new)
Description :  Displays NeighborGroups list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/neighborGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NeighborGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDeviceSkus_ListBySubscription (new)
Description :  List Network Device SKUs for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkDeviceSku items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkDeviceSku properties ,
Required: True ,
}
{
model:
{
Description: Model of the network device. ,
Required: True ,
}
string ,
manufacturer:
{
Description: Manufacturer of the network device. ,
Required: False ,
}
string ,
supportedVersions:
{
Description: List of supported version details of network device. ,
Required: False ,
}
[
{
version:
{
Description: Operating system and firmware combined versions. ,
Required: False ,
}
string ,
vendorOsVersion:
{
Description: Operating system version. ,
Required: False ,
}
string ,
vendorFirmwareVersion:
{
Description: Firmware version. ,
Required: False ,
}
string ,
isDefault:
{
Description: If true newly provisioned Fabric will use this device version by default to bootstrap the network devices for the first time. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
}
,
]
,
supportedRoleTypes:
{
Description: Available roles for the network device. ,
Required: False ,
}
[
string ,
]
,
interfaces:
{
Description: List of network device interfaces. ,
Required: False ,
}
[
{
identifier:
{
Description: Interface identifier. Example: HundredGigE0/0. ,
Required: False ,
}
string ,
interfaceType:
{
Description: Interface type. ,
Required: False ,
}
string ,
supportedConnectorTypes:
{
Description: List of supported connector types. ,
Required: False ,
}
[
{
connectorType:
{
Description: Type of connector used. Example: Optical. ,
Required: False ,
}
string ,
maxSpeedInMbps:
{
Description: Maximum speed of the connector in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDeviceSkus_Get (new)
Description :  Get a Network Device SKU details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDeviceSkus/{networkDeviceSkuName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
networkDeviceSkuName:
{
Description: Name of the Network Device SKU. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkDeviceSku properties ,
Required: True ,
}
{
model:
{
Description: Model of the network device. ,
Required: True ,
}
string ,
manufacturer:
{
Description: Manufacturer of the network device. ,
Required: False ,
}
string ,
supportedVersions:
{
Description: List of supported version details of network device. ,
Required: False ,
}
[
{
version:
{
Description: Operating system and firmware combined versions. ,
Required: False ,
}
string ,
vendorOsVersion:
{
Description: Operating system version. ,
Required: False ,
}
string ,
vendorFirmwareVersion:
{
Description: Firmware version. ,
Required: False ,
}
string ,
isDefault:
{
Description: If true newly provisioned Fabric will use this device version by default to bootstrap the network devices for the first time. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
}
,
]
,
supportedRoleTypes:
{
Description: Available roles for the network device. ,
Required: False ,
}
[
string ,
]
,
interfaces:
{
Description: List of network device interfaces. ,
Required: False ,
}
[
{
identifier:
{
Description: Interface identifier. Example: HundredGigE0/0. ,
Required: False ,
}
string ,
interfaceType:
{
Description: Interface type. ,
Required: False ,
}
string ,
supportedConnectorTypes:
{
Description: List of supported connector types. ,
Required: False ,
}
[
{
connectorType:
{
Description: Type of connector used. Example: Optical. ,
Required: False ,
}
string ,
maxSpeedInMbps:
{
Description: Maximum speed of the connector in Mbps. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_ListBySubscription (new)
Description :  List all the Network Device resources in a given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkDevice items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricControllers_ListBySubscription (new)
Description :  Lists all the NetworkFabricControllers by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkFabricController items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricSkus_ListBySubscription (new)
Description :  Implements Network Fabric SKUs list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkFabricSku items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Network Fabric Sku properties ,
Required: True ,
}
{
type:
{
Description: Type of Network Fabric SKU. ,
Enum:
{
SingleRack: FabricSkuType-SingleRack ,
MultiRack: FabricSkuType-MultiRack ,
}
,
Required: False ,
}
enum ,
maxComputeRacks:
{
Description: Maximum number of compute racks available for this Network Fabric SKU. The value of max count racks is 4 for 4 rack SKU and 8 for 8 rack SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumServerCount:
{
Description: Maximum number of servers available for this Network Fabric SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedVersions:
{
Description: List of supported Network Fabric SKU versions. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: URL providing detailed configuration of the fabric SKU. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricSkus_Get (new)
Description :  Implements Network Fabric SKU GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabricSkus/{networkFabricSkuName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
networkFabricSkuName:
{
Description: Name of the Network Fabric SKU. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Network Fabric Sku properties ,
Required: True ,
}
{
type:
{
Description: Type of Network Fabric SKU. ,
Enum:
{
SingleRack: FabricSkuType-SingleRack ,
MultiRack: FabricSkuType-MultiRack ,
}
,
Required: False ,
}
enum ,
maxComputeRacks:
{
Description: Maximum number of compute racks available for this Network Fabric SKU. The value of max count racks is 4 for 4 rack SKU and 8 for 8 rack SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
maximumServerCount:
{
Description: Maximum number of servers available for this Network Fabric SKU. ,
Format: int32 ,
Required: False ,
}
integer ,
supportedVersions:
{
Description: List of supported Network Fabric SKU versions. ,
Required: False ,
}
[
string ,
]
,
details:
{
Description: URL providing detailed configuration of the fabric SKU. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_ListBySubscription (new)
Description :  List all the Network Fabric resources in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkFabrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkFabric items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkPacketBrokers_ListBySubscription (new)
Description :  Displays Network Packet Brokers list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkPacketBroker items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkRacks_ListBySubscription (new)
Description :  List all Network Rack resources in the given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkRacks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkRack items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_ListBySubscription (new)
Description :  List all the Network Tap Rule resources in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkTapRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkTapRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_ListBySubscription (new)
Description :  Displays Network Taps list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/networkTaps
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkTap items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_ListBySubscription (new)
Description :  Implements RoutePolicies list by subscription GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ManagedNetworkFabric/routePolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RoutePolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_ListByResourceGroup (new)
Description :  Implements AccessControlLists list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The AccessControlList items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_Get (new)
Description :  Implements Access Control List GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_Create (new)
Description :  Implements Access Control List PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Access Control List resource definition. ,
}
{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_Update (new)
Description :  API to update certain properties of the Access Control List resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
properties:
{
Description: Access Control List properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Access Control Lists patch properties. ,
Required: False ,
}
{
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: False ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: False ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Access ControlList properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Access Control List. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
aclsUrl:
{
Description: Access Control List file URL. ,
Format: uri ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
etherTypes:
{
Description: List of ether type values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
fragments:
{
Description: List of IP fragment packets that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipLengths:
{
Description: List of IP Lengths that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ttlValues:
{
Description: List of TTL [Time To Live] values that need to be matched. ,
Required: False ,
}
[
string ,
]
,
dscpMarkings:
{
Description: List of DSCP Markings that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
flags:
{
Description: List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: AclActionType Drop ,
Count: AclActionType Count ,
Log: AclActionType Log ,
}
,
Required: False ,
}
enum ,
counterName:
{
Description: Name of the counter block to get match count information. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
lastSyncedTime:
{
Description: The last synced timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_Delete (new)
Description :  Implements Access Control List DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_Resync (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/resync
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_UpdateAdministrativeState (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AccessControlLists_ValidateConfiguration (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/accessControlLists/{accessControlListName}/validateConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accessControlListName:
{
Description: Name of the Access Control List. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGatewayRules_ListByResourceGroup (new)
Description :  Implements Internet Gateway Rules list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InternetGatewayRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGatewayRules_Get (new)
Description :  Gets an Internet Gateway Rule resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/{internetGatewayRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayRuleName:
{
Description: Name of the Internet Gateway rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGatewayRules_Create (new)
Description :  Creates an Internet Gateway rule resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/{internetGatewayRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayRuleName:
{
Description: Name of the Internet Gateway rule. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Internet Gateway Rule resource definition. ,
}
{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGatewayRules_Update (new)
Description :  API to update certain properties of the Internet Gateway Rule resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/{internetGatewayRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayRuleName:
{
Description: Name of the Internet Gateway rule. ,
Required: True ,
}
string ,
properties:
{
Description: Internet Gateway Rule properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Internet Gateway Rule properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ruleProperties:
{
Description: Rules for the InternetGateways ,
Required: True ,
}
{
action:
{
Description: Specify action. ,
Enum:
{
Allow: Action Allow ,
Deny: Action Deny ,
}
,
Required: True ,
}
enum ,
addressList:
{
Description: List of Addresses to be allowed or denied. ,
Required: True ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
internetGatewayIds:
{
Description: List of Internet Gateway resource Id. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGatewayRules_Delete (new)
Description :  Implements Internet Gateway Rules DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGatewayRules/{internetGatewayRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayRuleName:
{
Description: Name of the Internet Gateway rule. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGateways_ListByResourceGroup (new)
Description :  Displays Internet Gateways list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InternetGateway items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGateways_Get (new)
Description :  Implements Gateway GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways/{internetGatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayName:
{
Description: Name of the Internet Gateway. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGateways_Create (new)
Description :  Creates a Network Fabric Service Internet Gateway resource instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways/{internetGatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayName:
{
Description: Name of the Internet Gateway. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Internet Gateway resource definition. ,
}
{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGateways_Update (new)
Description :  Execute patch on Network Fabric Service Internet Gateway.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways/{internetGatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayName:
{
Description: Name of the Internet Gateway. ,
Required: True ,
}
string ,
properties:
{
Description: API to update certain properties of the InternetGateway resource.. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Internet Gateway Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
internetGatewayRuleId:
{
Description: ARM Resource ID of the Internet Gateway Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
ipv4Address:
{
Description: IPv4 Address of Internet Gateway. ,
Required: False ,
}
string ,
port:
{
Description: Port number of Internet Gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
type:
{
Description: Gateway Type of the resource. ,
Enum:
{
Infrastructure: GatewayType Infrastructure ,
Workload: GatewayType Workload ,
}
,
Required: True ,
}
enum ,
networkFabricControllerId:
{
Description: ARM Resource ID of the Network Fabric Controller. ,
Format: arm-id ,
Required: True ,
}
string ,
provisioningState:
{
Description: Provisioning state of resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternetGateways_Delete (new)
Description :  Execute a delete on Network Fabric Service Internet Gateway.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/internetGateways/{internetGatewayName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
internetGatewayName:
{
Description: Name of the Internet Gateway. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpCommunities_ListByResourceGroup (new)
Description :  Implements IP Communities list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IpCommunity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpCommunities_Get (new)
Description :  Implements an IP Community GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipCommunityName:
{
Description: Name of the IP Community. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpCommunities_Create (new)
Description :  Implements an IP Community PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipCommunityName:
{
Description: Name of the IP Community. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The IP Community resource definition. ,
}
{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpCommunities_Update (new)
Description :  API to update certain properties of the IP Community resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipCommunityName:
{
Description: Name of the IP Community. ,
Required: True ,
}
string ,
properties:
{
Description: IP Community properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: IP Community patchable properties. ,
Required: False ,
}
{
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: False ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The IP Community Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipCommunityRules:
{
Description: List of IP Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
wellKnownCommunities:
{
Description: Supported well known Community List. ,
Required: False ,
}
[
string ,
]
,
communityMembers:
{
Description: List the community members of IP Community. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpCommunities_Delete (new)
Description :  Implements IP Community DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipCommunities/{ipCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipCommunityName:
{
Description: Name of the IP Community. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpExtendedCommunities_ListByResourceGroup (new)
Description :  Implements IpExtendedCommunities list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IpExtendedCommunity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpExtendedCommunities_Get (new)
Description :  Implements IP Extended Community GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipExtendedCommunityName:
{
Description: Name of the IP Extended Community. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpExtendedCommunities_Create (new)
Description :  Implements IP Extended Community PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipExtendedCommunityName:
{
Description: Name of the IP Extended Community. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The IP Extended Community resource definition. ,
}
{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpExtendedCommunities_Update (new)
Description :  API to update certain properties of the IP Extended Community resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipExtendedCommunityName:
{
Description: Name of the IP Extended Community. ,
Required: True ,
}
string ,
properties:
{
Description: IP Extended Community properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: IP Extended Community patchable properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: False ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The IpExtendedCommunity properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipExtendedCommunityRules:
{
Description: List of IP Extended Community Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
routeTargets:
{
Description: Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpExtendedCommunities_Delete (new)
Description :  Implements IP Extended Community DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipExtendedCommunities/{ipExtendedCommunityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipExtendedCommunityName:
{
Description: Name of the IP Extended Community. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpPrefixes_ListByResourceGroup (new)
Description :  Implements IpPrefixes list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The IpPrefix items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpPrefixes_Get (new)
Description :  Implements IP Prefix GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipPrefixName:
{
Description: Name of the IP Prefix. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpPrefixes_Create (new)
Description :  Implements IP Prefix PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipPrefixName:
{
Description: Name of the IP Prefix. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The IP Prefix resource definition. ,
}
{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpPrefixes_Update (new)
Description :  API to update certain properties of the IP Prefix resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipPrefixName:
{
Description: Name of the IP Prefix. ,
Required: True ,
}
string ,
properties:
{
Description: IP Prefix properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: IP Prefix patchable properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: False ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The IP Prefix properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
ipPrefixRules:
{
Description: The list of IP Prefix Rules. ,
Required: True ,
}
[
{
action:
{
Description: Action to be taken on the configuration. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: True ,
}
enum ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. ,
Format: int64 ,
Required: True ,
}
integer ,
networkPrefix:
{
Description: Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 ,
Required: True ,
}
string ,
condition:
{
Description: Specify prefix-list bounds. ,
Enum:
{
EqualTo: Condition-EqualTo ,
GreaterThanOrEqualTo: Condition-GreaterThanOrEqualTo ,
LesserThanOrEqualTo: Condition-LesserThanOrEqualTo ,
Range: Condition-Range ,
}
,
Required: False ,
}
enum ,
subnetMaskLength:
{
Description: SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. ,
Required: False ,
}
string ,
}
,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
IpPrefixes_Delete (new)
Description :  Implements IP Prefix DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/ipPrefixes/{ipPrefixName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ipPrefixName:
{
Description: Name of the IP Prefix. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_ListByResourceGroup (new)
Description :  Displays L2IsolationDomains list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The L2IsolationDomain items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_Get (new)
Description :  Implements L2 Isolation Domain GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_Create (new)
Description :  Creates layer 2 network connectivity between compute nodes within a rack and across racks.The configuration is applied on the devices only after the isolation domain is enabled.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The L2 Isolation Domain resource definition. ,
}
{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_Update (new)
Description :  API to update certain properties of the L2 Isolation Domain resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
properties:
{
Description: API to update certain properties of the L2 Isolation Domain resource.. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The L2IsolationDomain properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
vlanId:
{
Description: Vlan Identifier of the Network Fabric. Example: 501. ,
Format: int32 ,
Required: True ,
}
integer ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_Delete (new)
Description :  Deletes layer 2 connectivity between compute nodes by managed by named L2 Isolation name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_CommitConfiguration (new)
Description :  Commits the configuration of the given resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/commitConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_UpdateAdministrativeState (new)
Description :  Enables isolation domain across the fabric or on specified racks.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
successfulDevices:
{
Description: List of ARM Resource IDs for which the given action applied successfully. ,
Required: False ,
}
[
string ,
]
,
failedDevices:
{
Description: List of ARM Resource IDs for which the given action failed to apply. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L2IsolationDomains_ValidateConfiguration (new)
Description :  Validates the configuration of the resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l2IsolationDomains/{l2IsolationDomainName}/validateConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l2IsolationDomainName:
{
Description: Name of the L2 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_ListByResourceGroup (new)
Description :  Displays L3IsolationDomains list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The L3IsolationDomain items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_Get (new)
Description :  Retrieves details of this L3 Isolation Domain.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_Create (new)
Description :  Create isolation domain resources for layer 3 connectivity between compute nodes and for communication with external services .This configuration is applied on the devices only after the creation of networks is completed and isolation domain is enabled.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The L3 Isolation Domain resource definition. ,
}
{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_Update (new)
Description :  API to update certain properties of the L3 Isolation Domain resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
properties:
{
Description: API to update certain properties of the L3 Isolation Domain resource. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The L3 Isolation Domain Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
redistributeConnectedSubnets:
{
Description: Advertise Connected Subnets. Ex: "True" | "False". ,
Enum:
{
True: RedistributeConnectedSubnets-True ,
False: RedistributeConnectedSubnets-False ,
}
,
Required: False ,
}
enum ,
redistributeStaticRoutes:
{
Description: Advertise Static Routes. Ex: "True" | "False". ,
Enum:
{
True: RedistributeStaticRoutes-True ,
False: RedistributeStaticRoutes-False ,
}
,
Required: False ,
}
enum ,
aggregateRouteConfiguration:
{
Description: Aggregate route configurations. ,
Required: False ,
}
{
ipv4Routes:
{
Description: List of IPv4 Route prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
ipv6Routes:
{
Description: List of Ipv6Routes prefixes. ,
Required: False ,
}
[
{
prefix:
{
Description: IPv4 Prefix of the aggregate Ipv4Route. ,
Required: True ,
}
string ,
}
,
]
,
}
,
connectedSubnetRoutePolicy:
{
Description: Connected Subnet RoutePolicy ,
Required: False ,
}
{
exportRoutePolicyId:
{
Description: ARM Resource ID of the Route Policy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicy:
{
Description: Array of ARM Resource ID of the RoutePolicies. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
networkFabricId:
{
Description: ARM Resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_Delete (new)
Description :  Deletes layer 3 connectivity between compute nodes by managed by named L3 Isolation name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_CommitConfiguration (new)
Description :  Commits the configuration of the given resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/commitConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_ListByL3IsolationDomain (new)
Description :  Implements External Networks list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ExternalNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: External Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_Get (new)
Description :  Implements ExternalNetworks GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
externalNetworkName:
{
Description: Name of the External Network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: External Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_Create (new)
Description :  Creates ExternalNetwork PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
externalNetworkName:
{
Description: Name of the External Network. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: External Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: External Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Defines the External Network resource. ,
}
{
properties:
{
Description: External Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_Update (new)
Description :  API to update certain properties of the ExternalNetworks resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
externalNetworkName:
{
Description: Name of the External Network. ,
Required: True ,
}
string ,
properties:
{
Description: ExternalNetwork properties to update. Only annotations are supported. ,
Required: True ,
}
{
properties:
{
Description: External Network Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: False ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: False ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: False ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: External Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the networkToNetworkInterconnectId of the ExternalNetwork resource. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties object ,
Required: False ,
}
{
importRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: RouteTargets to be applied. This is used for the backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: RouteTargets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties object ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan identifier. Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: Fabric ASN number. Example 65001 ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_Delete (new)
Description :  Implements ExternalNetworks DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
externalNetworkName:
{
Description: Name of the External Network. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_UpdateAdministrativeState (new)
Description :  Executes update operation to enable or disable administrative State for externalNetwork.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
externalNetworkName:
{
Description: Name of the External Network. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExternalNetworks_UpdateStaticRouteBfdAdministrativeState (new)
Description :  Update Static Route BFD for external Network.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/externalNetworks/{externalNetworkName}/updateStaticRouteBfdAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
externalNetworkName:
{
Description: Name of the External Network. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_ListByL3IsolationDomain (new)
Description :  Displays InternalNetworks list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InternalNetwork items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The Internal Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
vlanId:
{
Description: Vlan identifier. Example: 1001. ,
Format: int32 ,
Required: True ,
}
integer ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: True ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_Get (new)
Description :  Gets a InternalNetworks.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Internal Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
vlanId:
{
Description: Vlan identifier. Example: 1001. ,
Format: int32 ,
Required: True ,
}
integer ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: True ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_Create (new)
Description :  Creates InternalNetwork PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The Internal Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
vlanId:
{
Description: Vlan identifier. Example: 1001. ,
Format: int32 ,
Required: True ,
}
integer ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: True ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Internal Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
vlanId:
{
Description: Vlan identifier. Example: 1001. ,
Format: int32 ,
Required: True ,
}
integer ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: True ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Defines the Internal Network resource. ,
}
{
properties:
{
Description: The Internal Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
vlanId:
{
Description: Vlan identifier. Example: 1001. ,
Format: int32 ,
Required: True ,
}
integer ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: True ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_Update (new)
Description :  Updates a InternalNetworks.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
properties:
{
Description: InternalNetwork properties to update. Only annotations are supported. ,
Required: True ,
}
{
properties:
{
Description: InternalNetwork Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: False ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Internal Network Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
mtu:
{
Description: Maximum transmission unit. Default value is 1500. ,
Format: int32 ,
Required: False ,
}
integer ,
connectedIPv4Subnets:
{
Description: List of Connected IPv4 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
connectedIPv6Subnets:
{
Description: List of connected IPv6 Subnets. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
prefix:
{
Description: Prefix of the Connected Subnet. ,
Required: True ,
}
string ,
}
,
]
,
importRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
exportRoutePolicyId:
{
Description: ARM Resource ID of the RoutePolicy. This is used for the backward compatibility. ,
Format: arm-id ,
Required: False ,
}
string ,
importRoutePolicy:
{
Description: Import Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy either IPv4 or IPv6. ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: ARM resource ID of RoutePolicy. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
isMonitoringEnabled:
{
Description: To check whether monitoring of internal network is enabled or not. ,
Enum:
{
True: IsMonitoringEnabled-True ,
False: IsMonitoringEnabled-False ,
}
,
Required: False ,
}
enum ,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
vlanId:
{
Description: Vlan identifier. Example: 1001. ,
Format: int32 ,
Required: True ,
}
integer ,
bgpConfiguration:
{
Description: BGP configuration properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
defaultRouteOriginate:
{
Description: Originate a defaultRoute. Ex: "True" | "False". ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
allowAS:
{
Description: Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. ,
Format: int32 ,
Required: False ,
}
integer ,
allowASOverride:
{
Description: Enable Or Disable state. ,
Enum:
{
Enable: AllowASOverride-Enable ,
Disable: AllowASOverride-Disable ,
}
,
Required: False ,
}
enum ,
fabricASN:
{
Description: ASN of Network Fabric. Example: 65048. ,
Format: int64 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN. Example: 65047. ,
Format: int64 ,
Required: True ,
}
integer ,
ipv4ListenRangePrefixes:
{
Description: List of BGP IPv4 Listen Range prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv6ListenRangePrefixes:
{
Description: List of BGP IPv6 Listen Ranges prefixes. ,
Required: False ,
}
[
string ,
]
,
ipv4NeighborAddress:
{
Description: List with stringified IPv4 Neighbor Addresses. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
ipv6NeighborAddress:
{
Description: List with stringified IPv6 Neighbor Address. ,
Required: False ,
}
[
{
address:
{
Description: IP Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
staticRouteConfiguration:
{
Description: Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD configuration properties ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
extension:
{
Description: Extension. Example: NoExtension | NPB. ,
Enum:
{
NoExtension: Extension-NoExtension ,
NPB: Extension-NPB ,
}
,
Required: False ,
}
enum ,
}
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_Delete (new)
Description :  Implements InternalNetworks DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_UpdateAdministrativeState (new)
Description :  Update Administrative state of InternalNetworks on resources referred by their resource ids.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_UpdateBgpAdministrativeState (new)
Description :  Update BGP state for internalNetwork. Allowed only on edge devices.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateBgpAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
InternalNetworks_UpdateStaticRouteBfdAdministrativeState (new)
Description :  Update Static Route BFD administrative state for internalNetwork.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/internalNetworks/{internalNetworkName}/updateStaticRouteBfdAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
internalNetworkName:
{
Description: Name of the Internal Network. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_UpdateAdministrativeState (new)
Description :  Enables racks for this Isolation Domain.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
successfulDevices:
{
Description: List of ARM Resource IDs for which the given action applied successfully. ,
Required: False ,
}
[
string ,
]
,
failedDevices:
{
Description: List of ARM Resource IDs for which the given action failed to apply. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
L3IsolationDomains_ValidateConfiguration (new)
Description :  Validates the configuration of the resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/l3IsolationDomains/{l3IsolationDomainName}/validateConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
l3IsolationDomainName:
{
Description: Name of the L3 Isolation Domain. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeighborGroups_ListByResourceGroup (new)
Description :  Displays NeighborGroups list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NeighborGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeighborGroups_Get (new)
Description :  Gets the Neighbor Group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
neighborGroupName:
{
Description: Name of the Neighbor Group. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeighborGroups_Create (new)
Description :  Implements the Neighbor Group PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
neighborGroupName:
{
Description: Name of the Neighbor Group. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Defines the Neighbor Group. ,
}
{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeighborGroups_Update (new)
Description :  Updates the Neighbor Group.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
neighborGroupName:
{
Description: Name of the Neighbor Group. ,
Required: True ,
}
string ,
properties:
{
Description: Neighbor Group properties to update. Only annotations are supported. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Neighbor Group Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: False ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NeighborGroup Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
destination:
{
Description: An array of destination IPv4 Addresses or IPv6 Addresses. ,
Required: True ,
}
{
ipv4Addresses:
{
Description: Array of IPv4 Addresses. ,
Required: False ,
}
[
string ,
]
,
ipv6Addresses:
{
Description: Array of IPv6 Addresses. ,
Required: False ,
}
[
string ,
]
,
}
,
networkTapIds:
{
Description: List of NetworkTap IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
networkTapRuleIds:
{
Description: List of Network Tap Rule IDs where neighbor group is associated. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NeighborGroups_Delete (new)
Description :  Implements Neighbor Group DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
neighborGroupName:
{
Description: Name of the Neighbor Group. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_ListByResourceGroup (new)
Description :  List all the Network Device resources in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkDevice items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_Get (new)
Description :  Gets the Network Device resource details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_Create (new)
Description :  Create a Network Device resource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Network Device resource definition. ,
}
{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_Update (new)
Description :  Update certain properties of the Network Device resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
properties:
{
Description: Network Device properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Network Device Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkDevice properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the device. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the device. Format of serial Number - Make;Model;HardwareRevisionId;SerialNumber. ,
Required: True ,
}
string ,
version:
{
Description: Current version of the device as defined in SKU. ,
Required: False ,
}
string ,
networkDeviceSku:
{
Description: Network Device SKU name. ,
Required: False ,
}
string ,
networkDeviceRole:
{
Description: NetworkDeviceRole is the device role: Example: CE | ToR. ,
Enum:
{
CE: NetworkDeviceRole-CE(Customer Edge) ,
ToR: NetworkDeviceRole-ToR(top of rack) ,
NPB: NetworkDeviceRole-NPB(Network Packet Broker) ,
TS: NetworkDeviceRole-TS(Terminal Server) ,
Management: NetworkDeviceRole-Management ,
}
,
Required: False ,
}
enum ,
networkRackId:
{
Description: Reference to network rack resource id. ,
Required: False ,
}
string ,
managementIpv4Address:
{
Description: Management IPv4 Address. ,
Required: False ,
}
string ,
managementIpv6Address:
{
Description: Management IPv6 Address. ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_Delete (new)
Description :  Delete the Network Device resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_ListByNetworkDevice (new)
Description :  List all the Network Interface resources in a given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkInterface items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkInterface properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
physicalIdentifier:
{
Description: Physical Identifier of the network interface. ,
Required: False ,
}
string ,
connectedTo:
{
Description: The ARM resource id of the interface or compute server its connected to. ,
Required: False ,
}
string ,
interfaceType:
{
Description: The Interface Type. Example: Management/Data ,
Enum:
{
Management: InterfaceType-Management ,
Data: InterfaceType-Data ,
}
,
Required: False ,
}
enum ,
ipv4Address:
{
Description: IPv4Address of the interface. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: IPv6Address of the interface. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Get (new)
Description :  Get the Network Interface resource details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the Network Interface. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkInterface properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
physicalIdentifier:
{
Description: Physical Identifier of the network interface. ,
Required: False ,
}
string ,
connectedTo:
{
Description: The ARM resource id of the interface or compute server its connected to. ,
Required: False ,
}
string ,
interfaceType:
{
Description: The Interface Type. Example: Management/Data ,
Enum:
{
Management: InterfaceType-Management ,
Data: InterfaceType-Data ,
}
,
Required: False ,
}
enum ,
ipv4Address:
{
Description: IPv4Address of the interface. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: IPv6Address of the interface. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Create (new)
Description :  Create a Network Interface resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the Network Interface. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkInterface properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
physicalIdentifier:
{
Description: Physical Identifier of the network interface. ,
Required: False ,
}
string ,
connectedTo:
{
Description: The ARM resource id of the interface or compute server its connected to. ,
Required: False ,
}
string ,
interfaceType:
{
Description: The Interface Type. Example: Management/Data ,
Enum:
{
Management: InterfaceType-Management ,
Data: InterfaceType-Data ,
}
,
Required: False ,
}
enum ,
ipv4Address:
{
Description: IPv4Address of the interface. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: IPv6Address of the interface. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkInterface properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
physicalIdentifier:
{
Description: Physical Identifier of the network interface. ,
Required: False ,
}
string ,
connectedTo:
{
Description: The ARM resource id of the interface or compute server its connected to. ,
Required: False ,
}
string ,
interfaceType:
{
Description: The Interface Type. Example: Management/Data ,
Enum:
{
Management: InterfaceType-Management ,
Data: InterfaceType-Data ,
}
,
Required: False ,
}
enum ,
ipv4Address:
{
Description: IPv4Address of the interface. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: IPv6Address of the interface. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Defines the NetworkInterface resource. ,
}
{
properties:
{
Description: The NetworkInterface properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
physicalIdentifier:
{
Description: Physical Identifier of the network interface. ,
Required: False ,
}
string ,
connectedTo:
{
Description: The ARM resource id of the interface or compute server its connected to. ,
Required: False ,
}
string ,
interfaceType:
{
Description: The Interface Type. Example: Management/Data ,
Enum:
{
Management: InterfaceType-Management ,
Data: InterfaceType-Data ,
}
,
Required: False ,
}
enum ,
ipv4Address:
{
Description: IPv4Address of the interface. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: IPv6Address of the interface. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Update (new)
Description :  Update certain properties of the Network Interface resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the Network Interface. ,
Required: True ,
}
string ,
properties:
{
Description: NetworkInterface properties to update. Only tags are supported. ,
Required: True ,
}
{
properties:
{
Description: Network Interface Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkInterface properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
physicalIdentifier:
{
Description: Physical Identifier of the network interface. ,
Required: False ,
}
string ,
connectedTo:
{
Description: The ARM resource id of the interface or compute server its connected to. ,
Required: False ,
}
string ,
interfaceType:
{
Description: The Interface Type. Example: Management/Data ,
Enum:
{
Management: InterfaceType-Management ,
Data: InterfaceType-Data ,
}
,
Required: False ,
}
enum ,
ipv4Address:
{
Description: IPv4Address of the interface. ,
Required: False ,
}
string ,
ipv6Address:
{
Description: IPv6Address of the interface. ,
Required: False ,
}
string ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_Delete (new)
Description :  Delete the Network Interface resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the Network Interface. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkInterfaces_UpdateAdministrativeState (new)
Description :  Update the admin state of the Network Interface.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/networkInterfaces/{networkInterfaceName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
networkInterfaceName:
{
Description: Name of the Network Interface. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_Reboot (new)
Description :  Reboot the Network Device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/reboot
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
rebootType:
{
Description: Type of reboot to be performed. Example: GracefulRebootWithZTP ,
Enum:
{
GracefulRebootWithZTP: RebootType GracefulRebootWithZTP ,
GracefulRebootWithoutZTP: RebootType GracefulRebootWithoutZTP ,
UngracefulRebootWithZTP: RebootType UngracefulRebootWithZTP ,
UngracefulRebootWithoutZTP: RebootType UngracefulRebootWithoutZTP ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_RefreshConfiguration (new)
Description :  Refreshes the configuration the Network Device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/refreshConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_RunRoCommand (new)
Description :  Run the RO Command on the Network Device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/runRoCommand
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
body:
{
Description: Request the command. ,
Required: True ,
}
{
command:
{
Description: Specify the command. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
outputUrl:
{
Description: Predefined link containing Device RO Command output. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_RunRwCommand (new)
Description :  Run the RW Command on the Network Device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/runRwCommand
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
body:
{
Description: Request the command. ,
Required: True ,
}
{
command:
{
Description: Specify the command. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
outputUrl:
{
Description: Predefined link containing Device Rw Command output. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_UpdateAdministrativeState (new)
Description :  Updates the Administrative state of the Network Device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
RMA: Device AdministrativeState-RMA ,
Resync: Device AdministrativeState-Resync ,
GracefulQuarantine: Device AdministrativeState-GracefulQuarantine ,
Quarantine: Device AdministrativeState-Quarantine ,
UnderMaintenance: Device AdministrativeState-UnderMaintenance ,
Enable: Device AdministrativeState-Enable ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkDevices_Upgrade (new)
Description :  Upgrades the version of the Network Device.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkDevices/{networkDeviceName}/upgrade
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkDeviceName:
{
Description: Name of the Network Device. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
version:
{
Description: Specify the version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricControllers_ListByResourceGroup (new)
Description :  Lists all the NetworkFabricControllers thats available in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkFabricController items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricControllers_Get (new)
Description :  Shows the provisioning status of Network Fabric Controller.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/{networkFabricControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricControllerName:
{
Description: Name of the Network Fabric Controller. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricControllers_Create (new)
Description :  Creates a Network Fabric Controller.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/{networkFabricControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricControllerName:
{
Description: Name of the Network Fabric Controller. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Network Fabric Controller resource definition. ,
}
{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricControllers_Update (new)
Description :  Updates are currently not supported for the Network Fabric Controller resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/{networkFabricControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricControllerName:
{
Description: Name of the Network Fabric Controller. ,
Required: True ,
}
string ,
properties:
{
Description: Network Fabric Controller properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Network Fabric Controller patch properties. ,
Required: False ,
}
{
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkFabricController Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
infrastructureExpressRouteConnections:
{
Description: As part of an update, the Infrastructure ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Infrastructure services. (This is a Mandatory attribute) ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
workloadExpressRouteConnections:
{
Description: As part of an update, the workload ExpressRoute CircuitID should be provided to create and Provision a NFC. This Express route is dedicated for Workload services. (This is a Mandatory attribute). ,
Required: False ,
}
[
{
expressRouteCircuitId:
{
Description: The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. ,
Format: arm-id ,
Required: True ,
}
string ,
expressRouteAuthorizationKey:
{
Description: Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. ,
Format: password ,
Required: True ,
}
string ,
}
,
]
,
infrastructureServices:
{
Description: InfrastructureServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
workloadServices:
{
Description: WorkloadServices IP ranges. ,
Required: False ,
}
{
ipv4AddressSpaces:
{
Description: The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. ,
Required: False ,
}
[
string ,
]
,
ipv6AddressSpaces:
{
Description: The IPv6 is not supported right now. ,
Required: False ,
}
[
string ,
]
,
}
,
managedResourceGroupConfiguration:
{
Description: Managed Resource Group configuration properties. ,
Required: False ,
}
{
name:
{
Description: The NFC service will be hosted in a Managed resource group. ,
Required: False ,
}
string ,
location:
{
Description: Managed resource group location. ,
Required: False ,
}
string ,
}
,
networkFabricIds:
{
Description: The NF-ID will be an input parameter used by the NF to link and get associated with the parent NFC Service. ,
Required: False ,
}
[
string ,
]
,
workloadManagementNetwork:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. This is used for the backward compatibility. ,
Required: False ,
}
boolean ,
isWorkloadManagementNetworkEnabled:
{
Description: A workload management network is required for all the tenant (workload) traffic. This traffic is only dedicated for Tenant workloads which are required to access internet or any other MSFT/Public endpoints. ,
Enum:
{
True: IsWorkloadManagementNetworkEnabled-True ,
False: IsWorkloadManagementNetworkEnabled-False ,
}
,
Required: False ,
}
enum ,
tenantInternetGatewayIds:
{
Description: List of tenant InternetGateway resource IDs ,
Required: False ,
}
[
string ,
]
,
ipv4AddressSpace:
{
Description: IPv4 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
ipv6AddressSpace:
{
Description: IPv6 Network Fabric Controller Address Space. ,
Required: False ,
}
string ,
nfcSku:
{
Description: Network Fabric Controller SKU. ,
Enum:
{
Basic: NfcSku-Basic ,
Standard: NfcSku-Standard ,
HighPerformance: NfcSku-HighPerformance ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabricControllers_Delete (new)
Description :  Deletes the Network Fabric Controller resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabricControllers/{networkFabricControllerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricControllerName:
{
Description: Name of the Network Fabric Controller. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_ListByResourceGroup (new)
Description :  List all the Network Fabric resources in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkFabric items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Get (new)
Description :  Get Network Fabric resource details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Create (new)
Description :  Create Network Fabric resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Network Fabric resource definition. ,
}
{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Update (new)
Description :  Update certain properties of the Network Fabric resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
properties:
{
Description: Network Fabric properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Network Fabric Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: False ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: False ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59. ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration already applied to terminal server. ,
Required: False ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: False ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: False ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: False ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: False ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: False ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: False ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: False ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: False ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: False ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkFabric Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkFabricSku:
{
Description: Supported Network Fabric SKU.Example: Compute / Aggregate racks. Once the user chooses a particular SKU, only supported racks can be added to the Network Fabric. The SKU determines whether it is a single / multi rack Network Fabric. ,
Required: True ,
}
string ,
fabricVersion:
{
Description: The version of Network Fabric. ,
Required: False ,
}
string ,
routerIds:
{
Description: Array of router IDs. ,
Required: False ,
}
[
string ,
]
,
networkFabricControllerId:
{
Description: Azure resource ID for the NetworkFabricController the NetworkFabric belongs. ,
Format: arm-id ,
Required: True ,
}
string ,
rackCount:
{
Description: Number of compute racks associated to Network Fabric. ,
Format: int32 ,
Required: False ,
}
integer ,
serverCountPerRack:
{
Description: Number of servers.Possible values are from 1-16. ,
Format: int32 ,
Required: True ,
}
integer ,
ipv4Prefix:
{
Description: IPv4Prefix for Management Network. Example: 10.1.0.0/19. ,
Required: True ,
}
string ,
ipv6Prefix:
{
Description: IPv6Prefix for Management Network. Example: 3FFE:FFFF:0:CD40::/59 ,
Required: False ,
}
string ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: True ,
}
integer ,
terminalServerConfiguration:
{
Description: Network and credentials configuration currently applied to terminal server. ,
Required: True ,
}
{
username:
{
Description: Username for the terminal server connection. ,
Required: True ,
}
string ,
password:
{
Description: Password for the terminal server connection. ,
Format: password ,
Required: True ,
}
string ,
serialNumber:
{
Description: Serial Number of Terminal server. ,
Required: False ,
}
string ,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: True ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: True ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
networkDeviceId:
{
Description: ARM Resource ID used for the NetworkDevice. ,
Required: False ,
}
string ,
}
,
managementNetworkConfiguration:
{
Description: Configuration to be used to setup the management network. ,
Required: True ,
}
{
infrastructureVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
workloadVpnConfiguration:
{
Description: VPN Configuration properties. ,
Required: True ,
}
{
networkToNetworkInterconnectId:
{
Description: ARM Resource ID of the Network To Network Interconnect. ,
Format: arm-id ,
Required: False ,
}
string ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
peeringOption:
{
Description: Peering option list. ,
Enum:
{
OptionA: PeeringOption-OptionA ,
OptionB: PeeringOption-OptionB ,
}
,
Required: True ,
}
enum ,
optionBProperties:
{
Description: option B properties ,
Required: False ,
}
{
importRouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
exportRouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. ,
Required: False ,
}
[
string ,
]
,
routeTargets:
{
Description: Route Targets to be applied. ,
Required: False ,
}
{
importIpv4RouteTargets:
{
Description: Route Targets to be applied for incoming routes into CE. ,
Required: False ,
}
[
string ,
]
,
importIpv6RouteTargets:
{
Description: Route Targets to be applied for incoming routes from CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv4RouteTargets:
{
Description: Route Targets to be applied for outgoing routes into CE. ,
Required: False ,
}
[
string ,
]
,
exportIpv6RouteTargets:
{
Description: Route Targets to be applied for outgoing routes from CE. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
optionAProperties:
{
Description: option A properties ,
Required: False ,
}
{
mtu:
{
Description: MTU to use for option A peering. ,
Format: int32 ,
Required: False ,
}
integer ,
vlanId:
{
Description: Vlan Id.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
peerASN:
{
Description: Peer ASN number.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
}
,
}
,
}
,
racks:
{
Description: List of NetworkRack resource IDs under the Network Fabric. The number of racks allowed depends on the Network Fabric SKU. ,
Required: False ,
}
[
string ,
]
,
l2IsolationDomains:
{
Description: List of L2 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
l3IsolationDomains:
{
Description: List of L3 Isolation Domain resource IDs under the Network Fabric. ,
Required: False ,
}
[
string ,
]
,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of NFC provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Delete (new)
Description :  Delete Network Fabric resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_CommitConfiguration (new)
Description :  Atomic update of the given Network Fabric instance. Sync update of NFA resources at Fabric level.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/commitConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Deprovision (new)
Description :  Deprovisions the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/deprovision
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
successfulDevices:
{
Description: List of ARM Resource IDs for which the given action applied successfully. ,
Required: False ,
}
[
string ,
]
,
failedDevices:
{
Description: List of ARM Resource IDs for which the given action failed to apply. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_GetTopology (new)
Description :  Gets Topology of the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/getTopology
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_ListByNetworkFabric (new)
Description :  Implements Network To Network Interconnects list by Network Fabric GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkToNetworkInterconnect items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkToNetworkInterconnect Properties ,
Required: True ,
}
{
nniType:
{
Description: Type of NNI used. Example: CE | NPB ,
Enum:
{
CE: NniType-CE(Customer Edge). ,
NPB: NniType-NPB(Network Packet Broker). ,
}
,
Required: False ,
}
enum ,
isManagementType:
{
Description: Configuration to use NNI for Infrastructure Management. Example: True/False. ,
Enum:
{
True: IsManagementType-True ,
False: IsManagementType-False ,
}
,
Required: False ,
}
enum ,
useOptionB:
{
Description: Based on this option layer3 parameters are mandatory. Example: True/False ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: True ,
}
enum ,
layer2Configuration:
{
Description: Common properties for Layer2 Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_Get (new)
Description :  Implements NetworkToNetworkInterconnects GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
networkToNetworkInterconnectName:
{
Description: Name of the Network to Network Interconnect. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkToNetworkInterconnect Properties ,
Required: True ,
}
{
nniType:
{
Description: Type of NNI used. Example: CE | NPB ,
Enum:
{
CE: NniType-CE(Customer Edge). ,
NPB: NniType-NPB(Network Packet Broker). ,
}
,
Required: False ,
}
enum ,
isManagementType:
{
Description: Configuration to use NNI for Infrastructure Management. Example: True/False. ,
Enum:
{
True: IsManagementType-True ,
False: IsManagementType-False ,
}
,
Required: False ,
}
enum ,
useOptionB:
{
Description: Based on this option layer3 parameters are mandatory. Example: True/False ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: True ,
}
enum ,
layer2Configuration:
{
Description: Common properties for Layer2 Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_Create (new)
Description :  Configuration used to setup CE-PE connectivity PUT Method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
networkToNetworkInterconnectName:
{
Description: Name of the Network to Network Interconnect. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkToNetworkInterconnect Properties ,
Required: True ,
}
{
nniType:
{
Description: Type of NNI used. Example: CE | NPB ,
Enum:
{
CE: NniType-CE(Customer Edge). ,
NPB: NniType-NPB(Network Packet Broker). ,
}
,
Required: False ,
}
enum ,
isManagementType:
{
Description: Configuration to use NNI for Infrastructure Management. Example: True/False. ,
Enum:
{
True: IsManagementType-True ,
False: IsManagementType-False ,
}
,
Required: False ,
}
enum ,
useOptionB:
{
Description: Based on this option layer3 parameters are mandatory. Example: True/False ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: True ,
}
enum ,
layer2Configuration:
{
Description: Common properties for Layer2 Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkToNetworkInterconnect Properties ,
Required: True ,
}
{
nniType:
{
Description: Type of NNI used. Example: CE | NPB ,
Enum:
{
CE: NniType-CE(Customer Edge). ,
NPB: NniType-NPB(Network Packet Broker). ,
}
,
Required: False ,
}
enum ,
isManagementType:
{
Description: Configuration to use NNI for Infrastructure Management. Example: True/False. ,
Enum:
{
True: IsManagementType-True ,
False: IsManagementType-False ,
}
,
Required: False ,
}
enum ,
useOptionB:
{
Description: Based on this option layer3 parameters are mandatory. Example: True/False ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: True ,
}
enum ,
layer2Configuration:
{
Description: Common properties for Layer2 Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Network To Network Interconnect resource definition. ,
}
{
properties:
{
Description: The NetworkToNetworkInterconnect Properties ,
Required: True ,
}
{
nniType:
{
Description: Type of NNI used. Example: CE | NPB ,
Enum:
{
CE: NniType-CE(Customer Edge). ,
NPB: NniType-NPB(Network Packet Broker). ,
}
,
Required: False ,
}
enum ,
isManagementType:
{
Description: Configuration to use NNI for Infrastructure Management. Example: True/False. ,
Enum:
{
True: IsManagementType-True ,
False: IsManagementType-False ,
}
,
Required: False ,
}
enum ,
useOptionB:
{
Description: Based on this option layer3 parameters are mandatory. Example: True/False ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: True ,
}
enum ,
layer2Configuration:
{
Description: Common properties for Layer2 Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_Update (new)
Description :  Update certain properties of the Network To NetworkInterconnects resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
networkToNetworkInterconnectName:
{
Description: Name of the Network to Network Interconnect. ,
Required: True ,
}
string ,
properties:
{
Description: Network to Network Interconnect properties to update. ,
Required: True ,
}
{
id:
{
Description: Fully qualified resource ID for the resource. E.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' ,
Format: arm-id ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. E.g. 'Microsoft.Compute/virtualMachines' or 'Microsoft.Storage/storageAccounts' ,
Required: False ,
}
string ,
systemData:
{
Description: Azure Resource Manager metadata containing createdBy and modifiedBy information. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
layer2Configuration:
{
Description: Common properties for Layer2Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: False ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: False ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkToNetworkInterconnect Properties ,
Required: True ,
}
{
nniType:
{
Description: Type of NNI used. Example: CE | NPB ,
Enum:
{
CE: NniType-CE(Customer Edge). ,
NPB: NniType-NPB(Network Packet Broker). ,
}
,
Required: False ,
}
enum ,
isManagementType:
{
Description: Configuration to use NNI for Infrastructure Management. Example: True/False. ,
Enum:
{
True: IsManagementType-True ,
False: IsManagementType-False ,
}
,
Required: False ,
}
enum ,
useOptionB:
{
Description: Based on this option layer3 parameters are mandatory. Example: True/False ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: True ,
}
enum ,
layer2Configuration:
{
Description: Common properties for Layer2 Configuration. ,
Required: False ,
}
{
mtu:
{
Description: MTU of the packets between PE & CE. ,
Format: int32 ,
Required: False ,
}
integer ,
interfaces:
{
Description: List of network device interfaces resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
optionBLayer3Configuration:
{
Description: Common properties for Layer3Configuration. ,
Required: False ,
}
{
primaryIpv4Prefix:
{
Description: IPv4 Address Prefix. ,
Required: False ,
}
string ,
primaryIpv6Prefix:
{
Description: IPv6 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv4Prefix:
{
Description: Secondary IPv4 Address Prefix. ,
Required: False ,
}
string ,
secondaryIpv6Prefix:
{
Description: Secondary IPv6 Address Prefix. ,
Required: False ,
}
string ,
peerASN:
{
Description: ASN of PE devices for CE/PE connectivity.Example : 28 ,
Format: int64 ,
Required: True ,
}
integer ,
vlanId:
{
Description: VLAN for CE/PE Layer 3 connectivity.Example : 501 ,
Format: int32 ,
Required: True ,
}
integer ,
fabricASN:
{
Description: ASN of CE devices for CE/PE connectivity. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
npbStaticRouteConfiguration:
{
Description: NPB Static Route Configuration properties. ,
Required: False ,
}
{
bfdConfiguration:
{
Description: BFD Configuration properties. ,
Required: False ,
}
{
administrativeState:
{
Description: Administrative state of the BfdConfiguration. Example: Enabled | Disabled. ,
Enum:
{
Enabled: Represents the enabled state of BFD administrative state. ,
Disabled: Represents the disabled state of BFD administrative state. ,
MAT: Represents the MAT(Manual Action Taken) state of BFD administrative state. ,
RMA: Represents the RMA(Return Material Authorization) state of BFD administrative state. ,
}
,
Required: False ,
}
enum ,
intervalInMilliSeconds:
{
Description: Interval in milliseconds. Example: 300. ,
Format: int32 ,
Required: False ,
}
integer ,
multiplier:
{
Description: Multiplier for the Bfd Configuration. Example: 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
ipv4Routes:
{
Description: List of IPv4 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
ipv6Routes:
{
Description: List of IPv6 Routes. ,
Required: False ,
}
[
{
prefix:
{
Description: Prefix of the route. ,
Required: True ,
}
string ,
nextHop:
{
Description: List of next hop addresses. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
}
,
importRoutePolicy:
{
Description: Import Route Policy information. ,
Required: False ,
}
{
importIpv4RoutePolicyId:
{
Description: Import IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
importIpv6RoutePolicyId:
{
Description: Import IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
exportRoutePolicy:
{
Description: Export Route Policy information ,
Required: False ,
}
{
exportIpv4RoutePolicyId:
{
Description: Export IPv4 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
exportIpv6RoutePolicyId:
{
Description: Export IPv6 Route Policy Id. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
egressAclId:
{
Description: Egress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
ingressAclId:
{
Description: Ingress Acl. ARM resource ID of Access Control Lists. ,
Format: arm-id ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_Delete (new)
Description :  Implements NetworkToNetworkInterconnects DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
networkToNetworkInterconnectName:
{
Description: Name of the Network to Network Interconnect. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_UpdateAdministrativeState (new)
Description :  Updates the Admin State.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
networkToNetworkInterconnectName:
{
Description: Name of the Network to Network Interconnect. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkToNetworkInterconnects_UpdateNpbStaticRouteBfdAdministrativeState (new)
Description :  Updates the NPB Static Route BFD Administrative State.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/networkToNetworkInterconnects/{networkToNetworkInterconnectName}/updateNpbStaticRouteBfdAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
networkToNetworkInterconnectName:
{
Description: Name of the Network to Network Interconnect. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Provision (new)
Description :  Provisions the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/provision
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
successfulDevices:
{
Description: List of ARM Resource IDs for which the given action applied successfully. ,
Required: False ,
}
[
string ,
]
,
failedDevices:
{
Description: List of ARM Resource IDs for which the given action failed to apply. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_RefreshConfiguration (new)
Description :  Refreshes the configuration of the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/refreshConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_UpdateInfraManagementBfdConfiguration (new)
Description :  Updates the Infra Management BFD Configuration of the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/updateInfraManagementBfdConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_UpdateWorkloadManagementBfdConfiguration (new)
Description :  Updates the Workload Management BFD Configuration of the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/updateWorkloadManagementBfdConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_Upgrade (new)
Description :  Upgrades the version of the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/upgrade
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
body:
{
Description: Network Fabric properties to update. ,
Required: True ,
}
{
version:
{
Description: Specify the version. ,
Required: False ,
}
string ,
action:
{
Description: Action to be performed while upgrading the fabric. ,
Enum:
{
Start: UpgradeAction-Start ,
Complete: UpgradeAction -Complete ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkFabrics_ValidateConfiguration (new)
Description :  Validates the configuration of the underlying resources in the given Network Fabric instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkFabrics/{networkFabricName}/validateConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkFabricName:
{
Description: Name of the Network Fabric. ,
Required: True ,
}
string ,
body:
{
Description: Validate configuration properties. ,
Required: True ,
}
{
validateAction:
{
Description: Validate action that to be performed ,
Enum:
{
Cabling: ValidateAction-Cabling ,
Configuration: ValidateAction-Configuration ,
Connectivity: ValidateAction-Connectivity ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkPacketBrokers_ListByResourceGroup (new)
Description :  Displays NetworkPacketBrokers list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkPacketBroker items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkPacketBrokers_Get (new)
Description :  Retrieves details of this Network Packet Broker.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/{networkPacketBrokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkPacketBrokerName:
{
Description: Name of the Network Packet Broker. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkPacketBrokers_Create (new)
Description :  Creates a Network Packet Broker.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/{networkPacketBrokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkPacketBrokerName:
{
Description: Name of the Network Packet Broker. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The NetworkPacketBroker resource definition. ,
}
{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkPacketBrokers_Update (new)
Description :  API to update certain properties of the Network Packet Broker resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/{networkPacketBrokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkPacketBrokerName:
{
Description: Name of the Network Packet Broker. ,
Required: True ,
}
string ,
properties:
{
Description: Network Packet Broker properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkPacketBroker properties ,
Required: True ,
}
{
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDeviceIds:
{
Description: List of ARM resource IDs of Network Devices [NPB]. ,
Required: False ,
}
[
string ,
]
,
sourceInterfaceIds:
{
Description: List of network interfaces across NPB devices that are used to mirror source traffic. ,
Required: False ,
}
[
string ,
]
,
networkTapIds:
{
Description: List of network Tap IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
neighborGroupIds:
{
Description: List of neighbor group IDs configured on NPB. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkPacketBrokers_Delete (new)
Description :  Deletes Network Packet Broker.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkPacketBrokers/{networkPacketBrokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkPacketBrokerName:
{
Description: Name of the Network Packet Broker. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkRacks_ListByResourceGroup (new)
Description :  List all Network Rack resources in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkRack items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkRacks_Get (new)
Description :  Get Network Rack resource details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks/{networkRackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkRackName:
{
Description: Name of the Network Rack. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkRacks_Create (new)
Description :  Create Network Rack resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks/{networkRackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkRackName:
{
Description: Name of the Network Rack. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Network Rack resource definition. ,
}
{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkRacks_Update (new)
Description :  Update certain properties of the Network Rack resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks/{networkRackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkRackName:
{
Description: Name of the Network Rack. ,
Required: True ,
}
string ,
properties:
{
Description: Network Rack properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkRack properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkRackType:
{
Description: Network Rack SKU name. ,
Enum:
{
Aggregate: NetworkRackType-Aggregate ,
Compute: NetworkRackType-Compute ,
Combined: NetworkRackType-Combined ,
}
,
Required: False ,
}
enum ,
networkFabricId:
{
Description: ARM resource ID of the Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
networkDevices:
{
Description: List of network device ARM resource IDs. ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkRacks_Delete (new)
Description :  Delete Network Rack resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkRacks/{networkRackName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkRackName:
{
Description: Name of the Network Rack. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_ListByResourceGroup (new)
Description :  List all the Network Tap Rule resources in the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkTapRule items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_Get (new)
Description :  Get Network Tap Rule resource details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_Create (new)
Description :  Create Network Tap Rule resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The NetworkTapRule resource definition. ,
}
{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_Update (new)
Description :  Update certain properties of the Network Tap Rule resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
properties:
{
Description: Network Tap Rule properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Network Tap Rule Patch properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: False ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: False ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkTapRule Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
configurationType:
{
Description: Input method to configure Network Tap Rule. ,
Enum:
{
File: File Configuration Type ,
Inline: Inline Configuration Type ,
}
,
Required: True ,
}
enum ,
tapRulesUrl:
{
Description: Network Tap Rules file URL. ,
Format: uri ,
Required: False ,
}
string ,
matchConfigurations:
{
Description: List of match configurations. ,
Required: False ,
}
[
{
matchConfigurationName:
{
Description: The name of the match configuration. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence Number of the match configuration.. ,
Format: int64 ,
Required: False ,
}
integer ,
ipAddressType:
{
Description: Type of IP Address. IPv4 or IPv6 ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
matchConditions:
{
Description: List of the match conditions. ,
Required: False ,
}
[
{
protocolTypes:
{
Description: List of the protocols that need to be matched. ,
Required: False ,
}
[
string ,
]
,
vlanMatchCondition:
{
Description: Vlan match condition that needs to be matched. ,
Required: False ,
}
{
vlans:
{
Description: List of vlans that need to be matched. Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
innerVlans:
{
Description: List of inner vlans that need to be matched.Inputs can be single vlan or the range of vlans. ,
Required: False ,
}
[
string ,
]
,
vlanGroupNames:
{
Description: List of vlan group names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
ipCondition:
{
Description: IP condition that needs to be matched. ,
Required: False ,
}
{
type:
{
Description: IP Address type that needs to be matched. ,
Enum:
{
SourceIP: SourceDestinationType SourceIP ,
DestinationIP: SourceDestinationType DestinationIP ,
}
,
Required: False ,
}
enum ,
prefixType:
{
Description: IP Prefix Type that needs to be matched. ,
Enum:
{
Prefix: PrefixType Prefix ,
LongestPrefix: PrefixType LongestPrefix ,
}
,
Required: False ,
}
enum ,
ipPrefixValues:
{
Description: The list of IP Prefixes that need to be matched. ,
Required: False ,
}
[
string ,
]
,
ipGroupNames:
{
Description: The List of IP Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
encapsulationType:
{
Description: Encapsulation Type that needs to be matched. ,
Enum:
{
None: None EncapsulationType ,
GTPv1: GTPv1 EncapsulationType ,
}
,
Required: False ,
}
enum ,
portCondition:
{
Description: Defines the port condition that needs to be matched. ,
Required: False ,
}
{
portType:
{
Description: Port type that needs to be matched. ,
Enum:
{
SourcePort: PortType SourcePort ,
DestinationPort: PortType DestinationPort ,
}
,
Required: False ,
}
enum ,
layer4Protocol:
{
Description: Layer4 protocol type that needs to be matched. ,
Enum:
{
TCP: TCP(Transmission Control Protocol) Protocol ,
UDP: UDP(User Datagram Protocol) Protocol ,
}
,
Required: True ,
}
enum ,
ports:
{
Description: List of the Ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
portGroupNames:
{
Description: List of the port Group Names that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
actions:
{
Description: List of actions that need to be performed for the matched conditions. ,
Required: False ,
}
[
{
type:
{
Description: Type of actions that can be performed. ,
Enum:
{
Drop: TapRuleActionType-Drop ,
Count: TapRuleActionType-Count ,
Log: TapRuleActionType-Log ,
Replicate: TapRuleActionType-Replicate ,
Goto: TapRuleActionType-Goto ,
Redirect: TapRuleActionType-Redirect ,
Mirror: TapRuleActionType-Mirror ,
}
,
Required: False ,
}
enum ,
truncate:
{
Description: Truncate. 0 indicates do not truncate. ,
Required: False ,
}
string ,
isTimestampEnabled:
{
Description: The parameter to enable or disable the timestamp. ,
Enum:
{
True: EnumProperty-True ,
False: EnumProperty-False ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. ,
Format: arm-id ,
Required: False ,
}
string ,
matchConfigurationName:
{
Description: The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
dynamicMatchConfigurations:
{
Description: List of dynamic match configurations. ,
Required: False ,
}
[
{
ipGroups:
{
Description: List of IP Groups. ,
Required: False ,
}
[
{
name:
{
Description: IP Group name. ,
Required: False ,
}
string ,
ipAddressType:
{
Description: IP Address type. ,
Enum:
{
IPv4: IPv4 IP address ,
IPv6: IPv6 IP address ,
}
,
Required: False ,
}
enum ,
ipPrefixes:
{
Description: List of IP Prefixes. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
vlanGroups:
{
Description: List of vlan groups. ,
Required: False ,
}
[
{
name:
{
Description: Vlan group name. ,
Required: False ,
}
string ,
vlans:
{
Description: List of vlans. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
portGroups:
{
Description: List of the port groups. ,
Required: False ,
}
[
{
name:
{
Description: The name of the port group. ,
Required: False ,
}
string ,
ports:
{
Description: List of the ports that need to be matched. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
networkTapId:
{
Description: The ARM resource Id of the NetworkTap. ,
Required: False ,
}
string ,
pollingIntervalInSeconds:
{
Description: Polling interval in seconds. ,
Required: False ,
}
number ,
lastSyncedTime:
{
Description: The last sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_Delete (new)
Description :  Delete Network Tap Rule resource.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_Resync (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/resync
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_UpdateAdministrativeState (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTapRules_ValidateConfiguration (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTapRules/{networkTapRuleName}/validateConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapRuleName:
{
Description: Name of the Network Tap Rule. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_ListByResourceGroup (new)
Description :  Displays Network Taps list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetworkTap items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_Get (new)
Description :  Retrieves details of this Network Tap.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapName:
{
Description: Name of the Network Tap. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_Create (new)
Description :  Creates a Network Tap.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapName:
{
Description: Name of the Network Tap. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The Network Tap resource definition. ,
}
{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_Update (new)
Description :  API to update certain properties of the Network Tap resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapName:
{
Description: Name of the Network Tap. ,
Required: True ,
}
string ,
properties:
{
Description: Network Tap properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
destinations:
{
Description: List of destination properties to send the filter traffic. ,
Required: False ,
}
[
{
name:
{
Description: Destination name. ,
Required: False ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: False ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: False ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The NetworkTap Properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
networkPacketBrokerId:
{
Description: ARM resource ID of the Network Packet Broker. ,
Format: arm-id ,
Required: True ,
}
string ,
sourceTapRuleId:
{
Description: Source Tap Rule Id. ARM Resource ID of the Network Tap Rule. ,
Format: arm-id ,
Required: False ,
}
string ,
destinations:
{
Description: List of destinations to send the filter traffic. ,
Required: True ,
}
[
{
name:
{
Description: Destination name. ,
Required: True ,
}
string ,
destinationType:
{
Description: Type of destination. Input can be IsolationDomain or Direct. ,
Enum:
{
IsolationDomain: DestinationType-IsolationDomain ,
Direct: DestinationType-Direct ,
}
,
Required: True ,
}
enum ,
destinationId:
{
Description: The destination Id. ARM Resource ID of either NNI or Internal Networks. ,
Format: arm-id ,
Required: True ,
}
string ,
isolationDomainProperties:
{
Description: Isolation Domain Properties. ,
Required: False ,
}
{
encapsulation:
{
Description: Type of encapsulation. ,
Enum:
{
None: Encapsulation-None ,
GRE: Encapsulation-GRE ,
}
,
Required: False ,
}
enum ,
neighborGroupIds:
{
Description: List of Neighbor Group IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
destinationTapRuleId:
{
Description: ARM Resource ID of destination Tap Rule that contains match configurations. ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
pollingType:
{
Description: Polling type. ,
Enum:
{
Pull: PollingType-Pull ,
Push: PollingType-Push ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Gets the configurations state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provides you the latest status of the NFC service, whether it is Accepted, updating, Succeeded or Failed. During this process, the states keep changing based on the status of Network Tap provisioning. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. Example -Enabled/Disabled ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_Delete (new)
Description :  Deletes Network Tap.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapName:
{
Description: Name of the Network Tap. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_Resync (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}/resync
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapName:
{
Description: Name of the Network Tap. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NetworkTaps_UpdateAdministrativeState (new)
Description :  Implements the operation to the underlying resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/networkTaps/{networkTapName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
networkTapName:
{
Description: Name of the Network Tap. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
successfulDevices:
{
Description: List of ARM Resource IDs for which the given action applied successfully. ,
Required: False ,
}
[
string ,
]
,
failedDevices:
{
Description: List of ARM Resource IDs for which the given action failed to apply. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_ListByResourceGroup (new)
Description :  Implements RoutePolicies list by resource group GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The RoutePolicy items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_Get (new)
Description :  Implements Route Policy GET method.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_Create (new)
Description :  Implements Route Policy PUT method.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
resource:
{
Description: Request payload. ,
Required: True ,
}
{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: The RoutePolicy resource definition. ,
}
{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_Update (new)
Description :  API to update certain properties of the Route Policy resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
properties:
{
Description: Route Policy properties to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The RoutePolicy patchable properties. ,
Required: False ,
}
{
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: False ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The RoutePolicy properties ,
Required: True ,
}
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
defaultAction:
{
Description: Default action that needs to be applied when no condition is matched. Example: Permit | Deny. ,
Enum:
{
Permit: Permit Community Action Types ,
Deny: Deny Community Action Types ,
}
,
Required: False ,
}
enum ,
statements:
{
Description: Route Policy statements. ,
Required: True ,
}
[
{
annotation:
{
Description: Switch configuration description. ,
Required: False ,
}
string ,
sequenceNumber:
{
Description: Sequence to insert to/delete from existing route. ,
Format: int64 ,
Required: True ,
}
integer ,
condition:
{
Description: Route policy condition properties. ,
Required: True ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
type:
{
Description: Type of the condition used. ,
Enum:
{
Or: RoutePolicyConditionType-Or ,
And: RoutePolicyConditionType-And ,
}
,
Required: False ,
}
enum ,
ipPrefixId:
{
Description: Arm Resource Id of IpPrefix. ,
Required: False ,
}
string ,
}
,
action:
{
Description: Route policy action properties. ,
Required: True ,
}
{
localPreference:
{
Description: Local Preference of the route policy. ,
Format: int64 ,
Required: False ,
}
integer ,
actionType:
{
Description: Action type. Example: Permit | Deny | Continue. ,
Enum:
{
Permit: RoutePolicyActionType-Permit ,
Deny: RoutePolicyActionType-Deny ,
Continue: RoutePolicyActionType-Continue ,
}
,
Required: True ,
}
enum ,
ipCommunityProperties:
{
Description: IP Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Community IDs. ,
Required: False ,
}
{
ipCommunityIds:
{
Description: List of IP Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
ipExtendedCommunityProperties:
{
Description: IP Extended Community Properties. ,
Required: False ,
}
{
add:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
delete:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
set:
{
Description: List of IP Extended Community IDs. ,
Required: False ,
}
{
ipExtendedCommunityIds:
{
Description: List of IP Extended Community resource IDs. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}
,
]
,
networkFabricId:
{
Description: Arm Resource ID of Network Fabric. ,
Format: arm-id ,
Required: True ,
}
string ,
addressFamilyType:
{
Description: AddressFamilyType. This parameter decides whether the given ipv4 or ipv6 route policy. ,
Enum:
{
IPv4: AddressType-IPv4 ,
IPv6: AddressType-IPv6 ,
}
,
Required: False ,
}
enum ,
configurationState:
{
Description: Configuration state of the resource. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Provisioning state of the resource. ,
Enum:
{
Accepted: Accepted Provisioning State ,
Succeeded: Succeeded Provisioning State ,
Updating: Updating Provisioning State ,
Deleting: Deleting Provisioning State ,
Failed: Failed Provisioning State ,
Canceled: Canceled Provisioning State ,
}
,
Required: False ,
}
enum ,
administrativeState:
{
Description: Administrative state of the resource. ,
Enum:
{
Enabled: Enabled Administrative State ,
Disabled: Disabled Administrative State ,
MAT: MAT(Manual Action Taken) Administrative State ,
RMA: RMA(Return Material Authorization) Administrative State ,
UnderMaintenance: UnderMaintenance Administrative State ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_Delete (new)
Description :  Implements Route Policy DELETE method.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_CommitConfiguration (new)
Description :  Commits the configuration of the given resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/commitConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_UpdateAdministrativeState (new)
Description :  Updated the admin state for this Route Policy.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/updateAdministrativeState
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
body:
{
Description: Request payload. ,
Required: True ,
}
{
resourceIds:
{
Description: Network Fabrics or Network Rack resource Id. ,
Required: False ,
}
[
string ,
]
,
state:
{
Description: Administrative state. ,
Enum:
{
Enable: AdministrativeState Enable ,
Disable: AdministrativeState Disable ,
UnderMaintenance: AdministrativeState UnderMaintenance ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
successfulDevices:
{
Description: List of ARM Resource IDs for which the given action applied successfully. ,
Required: False ,
}
[
string ,
]
,
failedDevices:
{
Description: List of ARM Resource IDs for which the given action failed to apply. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RoutePolicies_ValidateConfiguration (new)
Description :  Validates the configuration of the resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/routePolicies/{routePolicyName}/validateConfiguration
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
routePolicyName:
{
Description: Name of the Route Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
configurationState:
{
Description: Gets the configuration state. ,
Enum:
{
Succeeded: Success Configuration State ,
Failed: Failed Configuration State ,
Rejected: Rejected Configuration State ,
Accepted: Accepted Configuration State ,
Provisioned: Provisioned Configuration State ,
ErrorProvisioning: ErrorProvisioning Configuration State ,
Deprovisioning: Deprovisioning Configuration State ,
Deprovisioned: Deprovisioned Configuration State ,
ErrorDeprovisioning: ErrorDeprovisioning Configuration State ,
DeferredControl: DeferredControl Configuration State ,
Provisioning: Provisioning Configuration State ,
PendingCommit: PendingCommit Configuration State ,
}
,
Required: False ,
}
enum ,
url:
{
Description: URL for the details of the response. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}