Microsoft Azure NetworkGroup is a service that provides customers with the ability to seamlessly connect and manage resources within their Azure cloud environment. The NetworkGroup allows users to create and configure virtual networks, set up dedicated connections to on-premises networks, and secure their network traffic through various security features such as firewalls and virtual private networks.
swagger: '2.0'
info:
title: Microsoft Azure NetworkGroup
description: >-
The Microsoft Azure Network Group API provides a RESTful set of web services
that interact with Microsoft Azure Network Manager service to manage your
network resources.
version: 2022-02-01-preview
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow.
scopes:
user_impersonation: impersonate your user account
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}
: parameters:
- $ref: ./network.json#/parameters/SubscriptionIdParameter
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/NetworkGroupNameParameter'
- $ref: ./network.json#/parameters/ApiVersionParameter
get:
tags:
- NetworkGroups
operationId: microsoftAzureNetworkgroupsGet
description: Gets the specified network group.
responses:
'200':
description: OK - Returns information about the network group.
schema:
$ref: '#/definitions/NetworkGroup'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
NetworkGroupsGet:
$ref: ./examples/NetworkManagerGroupGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname
put:
tags:
- NetworkGroups
operationId: microsoftAzureNetworkgroupsCreateorupdate
description: Creates or updates a network group.
parameters:
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/NetworkGroup'
description: >-
Parameters supplied to the specify which network group need to
create
- name: If-Match
in: header
required: false
type: string
x-ms-client-name: IfMatch
description: >-
The ETag of the transformation. Omit this value to always overwrite
the current resource. Specify the last-seen ETag value to prevent
accidentally overwriting concurrent changes.
responses:
'200':
description: Updated - Returns information about the network group.
schema:
$ref: '#/definitions/NetworkGroup'
headers:
ETag:
description: The current entity tag.
type: string
'201':
description: Created - Returns information about the network group.
schema:
$ref: '#/definitions/NetworkGroup'
headers:
ETag:
description: The current entity tag.
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
NetworkGroupsPut:
$ref: ./examples/NetworkManagerGroupPut.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname
delete:
tags:
- NetworkGroups
operationId: microsoftAzureNetworkgroupsDelete
description: Deletes a network group.
parameters:
- $ref: '#/parameters/ForceDeleteParameter'
responses:
'200':
description: Delete Succeed.
'204':
description: Request successful. The resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
NetworkGroupsDelete:
$ref: ./examples/NetworkManagerGroupDelete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups
: get:
tags:
- NetworkGroups
operationId: microsoftAzureNetworkgroupsList
description: Lists the specified network group.
x-ms-pageable:
nextLinkName: nextLink
parameters:
- $ref: ./network.json#/parameters/SubscriptionIdParameter
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: ./network.json#/parameters/ApiVersionParameter
- $ref: '#/parameters/ListTopParameter'
- $ref: '#/parameters/ListSkipTokenParameter'
responses:
'200':
description: OK - Returns information about the network group.
schema:
$ref: '#/definitions/NetworkGroupListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
NetworkGroupsList:
$ref: ./examples/NetworkManagerGroupList.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/listEffectiveVirtualNetworks
: post:
tags:
- NetworkGroups
operationId: microsoftAzureListeffectivevirtualnetworksBynetworkgroup
description: Lists all effective virtual networks by specified network group.
parameters:
- $ref: ./network.json#/parameters/SubscriptionIdParameter
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/NetworkGroupNameParameter'
- $ref: ./network.json#/parameters/ApiVersionParameter
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/QueryRequestOptions'
description: Parameters supplied to list correct page.
responses:
'200':
description: OK - Returns information about the effective virtual networks.
schema:
$ref: '#/definitions/EffectiveVirtualNetworksListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
NetworkManagerEffectiveVirtualNetworksList:
$ref: ./examples/NetworkManagerEffectiveVirtualNetworksList.json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname Listeffectivevirtualnetworks
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers/{staticMemberName}
: parameters:
- $ref: ./network.json#/parameters/SubscriptionIdParameter
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/NetworkGroupNameParameter'
- $ref: '#/parameters/StaticMemberNameParameter'
- $ref: ./network.json#/parameters/ApiVersionParameter
get:
tags:
- StaticMembers
operationId: microsoftAzureStaticmembersGet
description: Gets the specified static member.
responses:
'200':
description: OK - Returns information about the static member.
schema:
$ref: '#/definitions/StaticMember'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
StaticMembersGet:
$ref: ./examples/NetworkManagerStaticMemberGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname Staticmembers Staticmembername
put:
tags:
- StaticMembers
operationId: microsoftAzureStaticmembersCreateorupdate
description: Creates or updates a static member.
parameters:
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/StaticMember'
description: Parameters supplied to the specify the static member to create
responses:
'200':
description: Updated - Returns information about the static member.
schema:
$ref: '#/definitions/StaticMember'
'201':
description: Created - Returns information about the static member.
schema:
$ref: '#/definitions/StaticMember'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
StaticMemberPut:
$ref: ./examples/NetworkManagerStaticMemberPut.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname Staticmembers Staticmembername
delete:
tags:
- StaticMembers
operationId: microsoftAzureStaticmembersDelete
description: Deletes a static member.
responses:
'200':
description: Delete Succeed.
'204':
description: Request successful. The resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
StaticMembersDelete:
$ref: ./examples/NetworkManagerStaticMemberDelete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname Staticmembers Staticmembername
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkManagers/{networkManagerName}/networkGroups/{networkGroupName}/staticMembers
: get:
tags:
- StaticMembers
operationId: microsoftAzureStaticmembersList
description: Lists the specified static member.
x-ms-pageable:
nextLinkName: nextLink
parameters:
- $ref: ./network.json#/parameters/SubscriptionIdParameter
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/NetworkManagerNameParameter'
- $ref: '#/parameters/NetworkGroupNameParameter'
- $ref: ./network.json#/parameters/ApiVersionParameter
- $ref: '#/parameters/ListTopParameter'
- $ref: '#/parameters/ListSkipTokenParameter'
responses:
'200':
description: OK - Returns information about the static member.
schema:
$ref: '#/definitions/StaticMemberListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: ./network.json#/definitions/CloudError
x-ms-examples:
StaticMembersList:
$ref: ./examples/NetworkManagerStaticMemberList.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networkmanagers Networkmanagername Networkgroups Networkgroupname Staticmembers
definitions:
NetworkGroup:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/NetworkGroupProperties'
description: The Network Group properties
systemData:
readOnly: true
description: The system metadata related to this resource.
$ref: ./network.json#/definitions/SystemData
allOf:
- $ref: ./network.json#/definitions/ProxyResource
description: The network group resource
NetworkGroupListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/NetworkGroup'
description: Gets a page of NetworkGroup
nextLink:
type: string
description: Gets the URL to get the next set of results.
description: >-
Result of the request to list NetworkGroup. It contains a list of groups
and a URL link to get the next set of results.
NetworkGroupProperties:
type: object
properties:
description:
type: string
description: A description of the network group.
memberType:
type: string
description: Group member type.
provisioningState:
readOnly: true
$ref: ./network.json#/definitions/ProvisioningState
description: The provisioning state of the scope assignment resource.
required:
- memberType
description: Properties of network group
StaticMember:
type: object
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/StaticMemberProperties'
description: The Static Member properties
systemData:
readOnly: true
description: The system metadata related to this resource.
$ref: ./network.json#/definitions/SystemData
allOf:
- $ref: ./network.json#/definitions/ProxyResource
description: StaticMember Item.
StaticMemberListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/StaticMember'
description: Gets a page of StaticMember
nextLink:
type: string
description: Gets the URL to get the next set of results.
description: >-
Result of the request to list StaticMember. It contains a list of groups
and a URL link to get the next set of results.
StaticMemberProperties:
type: object
properties:
resourceId:
type: string
description: Resource Id.
description: Properties of static member.
QueryRequestOptions:
type: object
properties:
skipToken:
description: >-
When present, the value can be passed to a subsequent query call
(together with the same query and scopes used in the current request)
to retrieve the next page of data.
type: string
description: Query Request Options
EffectiveVirtualNetworksListResult:
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/EffectiveVirtualNetwork'
description: Gets a page of EffectiveVirtualNetwork
skipToken:
description: >-
When present, the value can be passed to a subsequent query call
(together with the same query and scopes used in the current request)
to retrieve the next page of data.
type: string
description: >-
Result of the request to list Effective Virtual Network. It contains a
list of groups and a URL link to get the next set of results.
EffectiveVirtualNetwork:
type: object
properties:
id:
type: string
description: Effective vnet Id.
location:
type: string
description: Location of vnet.
membershipType:
type: string
description: Membership Type.
enum:
- Static
- Dynamic
x-ms-enum:
name: MembershipType
modelAsString: true
description: Effective Virtual Network
parameters:
ResourceGroupNameParameter:
name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
x-ms-parameter-location: method
NetworkManagerNameParameter:
name: networkManagerName
in: path
required: true
type: string
description: The name of the network manager.
x-ms-parameter-location: method
NetworkGroupNameParameter:
name: networkGroupName
in: path
required: true
type: string
description: The name of the network group.
x-ms-parameter-location: method
StaticMemberNameParameter:
name: staticMemberName
in: path
required: true
type: string
description: The name of the static member.
x-ms-parameter-location: method
ListTopParameter:
name: $top
description: >-
An optional query parameter which specifies the maximum number of records
to be returned by the server.
in: query
required: false
type: integer
format: int32
minimum: 1
maximum: 20
x-ms-parameter-location: method
ListSkipTokenParameter:
name: $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.
in: query
required: false
type: string
x-ms-parameter-location: method
ForceDeleteParameter:
name: force
in: query
required: false
type: boolean
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.
x-ms-parameter-location: method
tags:
- name: NetworkGroups
- name: StaticMembers