Microsoft.Network (preview:2024-09-01)

2025/06/20 • 12 new methods

NetworkManagerRoutingConfigurations_List (new)
Description :  Lists all the network manager routing configurations in a network manager, in a paginated format.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations
{
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 ,
networkManagerName:
{
Description: The name of the network manager. ,
Required: True ,
}
string ,
$top:
{
Description: An optional query parameter which specifies the maximum number of records to be returned by the server. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets a page of routing configurations ,
Required: False ,
}
[
{
properties:
{
Description: Indicates the properties for the network manager routing configuration. ,
Required: False ,
}
{
description:
{
Description: A description of the routing configuration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the URL to get the next page of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkManagerRoutingConfigurations_Get (new)
Description :  Retrieves a network manager routing configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}
{}

⚐ Response (200)

{
properties:
{
Description: Indicates the properties for the network manager routing configuration. ,
Required: False ,
}
{
description:
{
Description: A description of the routing configuration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkManagerRoutingConfigurations_CreateOrUpdate (new)
Description :  Creates or updates a network manager routing configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}
{
routingConfiguration:
{
Description: The routing configuration to create or update ,
Required: True ,
}
{
properties:
{
Description: Indicates the properties for the network manager routing configuration. ,
Required: False ,
}
{
description:
{
Description: A description of the routing configuration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Indicates the properties for the network manager routing configuration. ,
Required: False ,
}
{
description:
{
Description: A description of the routing configuration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Indicates the properties for the network manager routing configuration. ,
Required: False ,
}
{
description:
{
Description: A description of the routing configuration. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
NetworkManagerRoutingConfigurations_Delete (new)
Description :  Deletes a network manager routing configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}
{
force:
{
Description: Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRuleCollections_List (new)
Description :  Lists all the rule collections in a routing configuration, in a paginated format.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections
{
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 ,
networkManagerName:
{
Description: The name of the network manager. ,
Required: True ,
}
string ,
configurationName:
{
Description: The name of the network manager Routing Configuration. ,
Required: True ,
}
string ,
$top:
{
Description: An optional query parameter which specifies the maximum number of records to be returned by the server. ,
Format: int32 ,
Required: False ,
}
integer ,
$skipToken:
{
Description: SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of network manager routing configuration rule collections ,
Required: False ,
}
[
{
properties:
{
Description: Indicates the properties for the network manager routing rule collection. ,
Required: False ,
}
{
description:
{
Description: A description of the routing rule collection. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
appliesTo:
{
Description: Groups for configuration ,
Required: True ,
}
[
{
networkGroupId:
{
Description: Network manager group Id. ,
Required: True ,
}
string ,
}
,
]
,
disableBgpRoutePropagation:
{
Description: Determines whether BGP route propagation is enabled. Defaults to true. ,
Enum:
{
False: No description available. ,
True: No description available. ,
}
,
Required: False ,
}
enum ,
peeringRoutePropagationRules:
{
Description: Rule to define peering route propagation behavior. ,
Required: False ,
}
[
{
propagationOption:
{
Description: Determines the peering route propogation rule behavior. Defaults to 'Default'. ,
Enum:
{
Default: No description available. ,
DisableAllPeeringPrefixes: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRuleCollections_Get (new)
Description :  Gets a network manager routing configuration rule collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}
{}

⚐ Response (200)

{
properties:
{
Description: Indicates the properties for the network manager routing rule collection. ,
Required: False ,
}
{
description:
{
Description: A description of the routing rule collection. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
appliesTo:
{
Description: Groups for configuration ,
Required: True ,
}
[
{
networkGroupId:
{
Description: Network manager group Id. ,
Required: True ,
}
string ,
}
,
]
,
disableBgpRoutePropagation:
{
Description: Determines whether BGP route propagation is enabled. Defaults to true. ,
Enum:
{
False: No description available. ,
True: No description available. ,
}
,
Required: False ,
}
enum ,
peeringRoutePropagationRules:
{
Description: Rule to define peering route propagation behavior. ,
Required: False ,
}
[
{
propagationOption:
{
Description: Determines the peering route propogation rule behavior. Defaults to 'Default'. ,
Enum:
{
Default: No description available. ,
DisableAllPeeringPrefixes: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRuleCollections_CreateOrUpdate (new)
Description :  Creates or updates a routing rule collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}
{
ruleCollection:
{
Description: The Rule Collection to create or update ,
Required: True ,
}
{
properties:
{
Description: Indicates the properties for the network manager routing rule collection. ,
Required: False ,
}
{
description:
{
Description: A description of the routing rule collection. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
appliesTo:
{
Description: Groups for configuration ,
Required: True ,
}
[
{
networkGroupId:
{
Description: Network manager group Id. ,
Required: True ,
}
string ,
}
,
]
,
disableBgpRoutePropagation:
{
Description: Determines whether BGP route propagation is enabled. Defaults to true. ,
Enum:
{
False: No description available. ,
True: No description available. ,
}
,
Required: False ,
}
enum ,
peeringRoutePropagationRules:
{
Description: Rule to define peering route propagation behavior. ,
Required: False ,
}
[
{
propagationOption:
{
Description: Determines the peering route propogation rule behavior. Defaults to 'Default'. ,
Enum:
{
Default: No description available. ,
DisableAllPeeringPrefixes: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Indicates the properties for the network manager routing rule collection. ,
Required: False ,
}
{
description:
{
Description: A description of the routing rule collection. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
appliesTo:
{
Description: Groups for configuration ,
Required: True ,
}
[
{
networkGroupId:
{
Description: Network manager group Id. ,
Required: True ,
}
string ,
}
,
]
,
disableBgpRoutePropagation:
{
Description: Determines whether BGP route propagation is enabled. Defaults to true. ,
Enum:
{
False: No description available. ,
True: No description available. ,
}
,
Required: False ,
}
enum ,
peeringRoutePropagationRules:
{
Description: Rule to define peering route propagation behavior. ,
Required: False ,
}
[
{
propagationOption:
{
Description: Determines the peering route propogation rule behavior. Defaults to 'Default'. ,
Enum:
{
Default: No description available. ,
DisableAllPeeringPrefixes: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Indicates the properties for the network manager routing rule collection. ,
Required: False ,
}
{
description:
{
Description: A description of the routing rule collection. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
appliesTo:
{
Description: Groups for configuration ,
Required: True ,
}
[
{
networkGroupId:
{
Description: Network manager group Id. ,
Required: True ,
}
string ,
}
,
]
,
disableBgpRoutePropagation:
{
Description: Determines whether BGP route propagation is enabled. Defaults to true. ,
Enum:
{
False: No description available. ,
True: No description available. ,
}
,
Required: False ,
}
enum ,
peeringRoutePropagationRules:
{
Description: Rule to define peering route propagation behavior. ,
Required: False ,
}
[
{
propagationOption:
{
Description: Determines the peering route propogation rule behavior. Defaults to 'Default'. ,
Enum:
{
Default: No description available. ,
DisableAllPeeringPrefixes: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRuleCollections_Delete (new)
Description :  Deletes an routing rule collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}
{
force:
{
Description: Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRules_List (new)
Description :  List all network manager routing configuration routing rules.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules
{}

⚐ Response (200)

{
value:
{
Description: A list of routing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Indicates the properties of the routing rule ,
Required: False ,
}
{
description:
{
Description: A description for this rule. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
destination:
{
Description: Indicates the destination for this particular rule. ,
Required: True ,
}
{
type:
{
Description: Destination type. ,
Enum:
{
AddressPrefix: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
destinationAddress:
{
Description: Destination address. ,
Required: True ,
}
string ,
}
,
nextHop:
{
Description: Indicates the next hop for this particular rule. ,
Required: True ,
}
{
nextHopType:
{
Description: Next hop type. ,
Enum:
{
Internet: No description available. ,
NoNextHop: No description available. ,
VirtualAppliance: No description available. ,
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopAddress:
{
Description: Next hop address. Only required if the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRules_Get (new)
Description :  Gets a network manager routing configuration routing rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
{}

⚐ Response (200)

{
properties:
{
Description: Indicates the properties of the routing rule ,
Required: False ,
}
{
description:
{
Description: A description for this rule. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
destination:
{
Description: Indicates the destination for this particular rule. ,
Required: True ,
}
{
type:
{
Description: Destination type. ,
Enum:
{
AddressPrefix: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
destinationAddress:
{
Description: Destination address. ,
Required: True ,
}
string ,
}
,
nextHop:
{
Description: Indicates the next hop for this particular rule. ,
Required: True ,
}
{
nextHopType:
{
Description: Next hop type. ,
Enum:
{
Internet: No description available. ,
NoNextHop: No description available. ,
VirtualAppliance: No description available. ,
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopAddress:
{
Description: Next hop address. Only required if the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRules_CreateOrUpdate (new)
Description :  Creates or updates an routing rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
{
routingRule:
{
Description: The routing rule to create or update ,
Required: True ,
}
{
properties:
{
Description: Indicates the properties of the routing rule ,
Required: False ,
}
{
description:
{
Description: A description for this rule. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
destination:
{
Description: Indicates the destination for this particular rule. ,
Required: True ,
}
{
type:
{
Description: Destination type. ,
Enum:
{
AddressPrefix: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
destinationAddress:
{
Description: Destination address. ,
Required: True ,
}
string ,
}
,
nextHop:
{
Description: Indicates the next hop for this particular rule. ,
Required: True ,
}
{
nextHopType:
{
Description: Next hop type. ,
Enum:
{
Internet: No description available. ,
NoNextHop: No description available. ,
VirtualAppliance: No description available. ,
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopAddress:
{
Description: Next hop address. Only required if the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Indicates the properties of the routing rule ,
Required: False ,
}
{
description:
{
Description: A description for this rule. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
destination:
{
Description: Indicates the destination for this particular rule. ,
Required: True ,
}
{
type:
{
Description: Destination type. ,
Enum:
{
AddressPrefix: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
destinationAddress:
{
Description: Destination address. ,
Required: True ,
}
string ,
}
,
nextHop:
{
Description: Indicates the next hop for this particular rule. ,
Required: True ,
}
{
nextHopType:
{
Description: Next hop type. ,
Enum:
{
Internet: No description available. ,
NoNextHop: No description available. ,
VirtualAppliance: No description available. ,
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopAddress:
{
Description: Next hop address. Only required if the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Indicates the properties of the routing rule ,
Required: False ,
}
{
description:
{
Description: A description for this rule. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
resourceGuid:
{
Description: Unique identifier for this resource. ,
Required: False ,
}
string ,
destination:
{
Description: Indicates the destination for this particular rule. ,
Required: True ,
}
{
type:
{
Description: Destination type. ,
Enum:
{
AddressPrefix: No description available. ,
ServiceTag: No description available. ,
}
,
Required: True ,
}
enum ,
destinationAddress:
{
Description: Destination address. ,
Required: True ,
}
string ,
}
,
nextHop:
{
Description: Indicates the next hop for this particular rule. ,
Required: True ,
}
{
nextHopType:
{
Description: Next hop type. ,
Enum:
{
Internet: No description available. ,
NoNextHop: No description available. ,
VirtualAppliance: No description available. ,
VirtualNetworkGateway: No description available. ,
VnetLocal: No description available. ,
}
,
Required: True ,
}
enum ,
nextHopAddress:
{
Description: Next hop address. Only required if the next hop type is VirtualAppliance. ,
Required: False ,
}
string ,
}
,
}
,
systemData:
{
Description: The system metadata related to this resource. ,
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 type of identity that last modified the resource. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RoutingRules_Delete (new)
Description :  Deletes a routing rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/routingConfigurations/{configurationName}/ruleCollections/{ruleCollectionName}/rules/{ruleName}
{
force:
{
Description: Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL of the resource used to check the status of the asynchronous operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}