Microsoft Azure

Microsoft Azure Network Manager Group Membership

Microsoft Azure Network Manager Group Membership allows users to create and manage groups within their network to easily organize and assign permissions to different users. This feature streamlines the process of managing access control within the network by providing an intuitive interface for users to easily add or remove members from groups.

Documentation GitHub OpenAPI

Documentation

📖

Documentation

https://learn.microsoft.com/en-us/azure/virtual-network-manager/concept-network-groups

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/networkmanagergroupmembership-openapi-original.yml

OpenAPI Specification

swagger: '2.0'
info:
  title: Microsoft Azure NetworkManagerGroupMembership
  description: >-
    The Microsoft Azure Network Manager Group Membership API provides a RESTful
    set of web services that interact with Microsoft Azure Networks service to
    manage your network resources. The API has entities that capture the
    relationship between an end user and the Microsoft Azure Networks service.
  version: 2022-06-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/virtualNetworks/{virtualNetworkName}/providers/Microsoft.Network/networkGroupMemberships
  : parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: >-
          ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/VirtualNetworkNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/FirstIndexParameter'
      - $ref: '#/parameters/PageSizeParameter'
    get:
      tags:
        - NetworkGroupMemberships_List
      operationId: microsoftAzureListnetworkgroupmemberships
      description: List networkGroupMemberships applied on a virtual network.
      responses:
        '200':
          description: OK - Returns information about the group membership.
          schema:
            $ref: '#/definitions/NetworkGroupMembershipsListResult'
        default:
          description: >-
            Resource Provider error response describing why the operation
            failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        List network group memberships:
          $ref: ./examples/NetworkGroupMembershipsList.json
      summary: >-
        Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Virtualnetworks Virtualnetworkname Providers Microsoft Network Networkgroupmemberships
definitions:
  NetworkGroupMembershipsListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NetworkGroupMembership'
        description: Gets a page of NetworkGroupMembership
      nextLink:
        type: string
        description: Gets the URL to get the next page of results.
    description: Result of the request to list NetworkGroupMembership.
  NetworkGroupMembership:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NetworkGroupMembershipProperties'
        description: The network group membership properties
      location:
        type: string
        description: Parent Resource Virtual Network Location.
    allOf:
      - $ref: >-
          ../../../../../common-types/resource-management/v4/types.json#/definitions/Resource
    description: Resource of networkGroupMembership.
  NetworkGroupMembershipProperties:
    type: object
    properties:
      groupMemberships:
        type: array
        items:
          $ref: '#/definitions/NetworkGroupMembershipGroup'
        description: GroupMembership list
    description: Network Group Membership Properties.
  NetworkGroupMembershipGroup:
    type: object
    properties:
      networkGroupId:
        type: string
        description: network Group ID.
      sources:
        type: array
        items:
          $ref: '#/definitions/BaseNetworkGroupMembershipSource'
        description: Source list
    description: The network manager Network Group Membership Group
  BaseNetworkGroupMembershipSource:
    type: object
    properties:
      kind:
        type: string
        description: >-
          Whether the NetworkGroupMembershipSource is StaticMembership or
          Policy.
        enum:
          - StaticMembership
          - Policy
        x-ms-enum:
          name: Type
          modelAsString: true
    required:
      - kind
    discriminator: kind
    description: Base Network Group Membership Source.
  StaticNetworkGroupMembershipSource:
    type: object
    properties:
      staticMemberId:
        type: string
        description: Static Member Id.
    allOf:
      - $ref: '#/definitions/BaseNetworkGroupMembershipSource'
    description: Static Network Group Membership Source.
    x-ms-discriminator-value: StaticMembership
  PolicyNetworkGroupMembershipSource:
    type: object
    properties:
      policyAssignmentId:
        type: string
        description: Policy Assignment Id.
      policySetDefinitionId:
        type: string
        description: Policy Set Definition Id.
      policyDefinitionId:
        type: string
        description: Policy Definition Id.
      policyDefinitionReferenceId:
        type: string
        description: Policy Definition Reference Id.
    allOf:
      - $ref: '#/definitions/BaseNetworkGroupMembershipSource'
    description: Policy Network Group Membership Source.
    x-ms-discriminator-value: Policy
parameters:
  VirtualNetworkNameParameter:
    name: virtualNetworkName
    in: path
    required: true
    type: string
    description: The name of the virtual network.
    x-ms-parameter-location: method
  PageSizeParameter:
    name: pageSize
    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
  FirstIndexParameter:
    name: firstIndex
    description: >-
      An optional query parameter which specifies the first index of records to
      be returned by the server.
    in: query
    required: false
    type: integer
    format: int32
    minimum: 0
    x-ms-parameter-location: method
tags:
  - name: NetworkGroupMemberships_List