Microsoft Azure NetworkSecurityGroups API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NetworkSecurityGroups API
schemes:
- https
tags:
- name: NetworkSecurityGroups
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}
  : delete:
      tags:
      - NetworkSecurityGroups
      operationId: microsoftAzureNetworksecuritygroupsDelete
      description: The Delete NetworkSecurityGroup operation deletes the specified network security group
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: networkSecurityGroupName
        in: path
        required: true
        type: string
        description: The name of the network security group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
        '202':
          description: ''
        '204':
          description: ''
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups Networksecuritygroupname
    get:
      tags:
      - NetworkSecurityGroups
      operationId: microsoftAzureNetworksecuritygroupsGet
      description: The Get NetworkSecurityGroups operation retrieves information about the specified network security group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: networkSecurityGroupName
        in: path
        required: true
        type: string
        description: The name of the network security group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkSecurityGroup'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups Networksecuritygroupname
    put:
      tags:
      - NetworkSecurityGroups
      operationId: microsoftAzureNetworksecuritygroupsCreateorupdate
      description: The Put NetworkSecurityGroup operation creates/updates a network security group in the specified resource group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - name: networkSecurityGroupName
        in: path
        required: true
        type: string
        description: The name of the network security group.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/NetworkSecurityGroup'
        description: Parameters supplied to the create/update Network Security Group operation
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkSecurityGroup'
        '201':
          description: ''
          schema:
            $ref: '#/definitions/NetworkSecurityGroup'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups Networksecuritygroupname
  /subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups:
    get:
      tags:
      - NetworkSecurityGroups
      operationId: microsoftAzureNetworksecuritygroupsListall
      description: The list NetworkSecurityGroups returns all network security groups in a subscription
      parameters:
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkSecurityGroupListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Network Networksecuritygroups
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups:
    get:
      tags:
      - NetworkSecurityGroups
      operationId: microsoftAzureNetworksecuritygroupsList
      description: The list NetworkSecurityGroups returns all network security groups in a resource group
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        type: string
        description: The name of the resource group.
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkSecurityGroupListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups
definitions:
  Resource:
    properties:
      id:
        readOnly: true
        type: string
        description: Resource Id
      name:
        readOnly: true
        type: string
        description: Resource name
      type:
        readOnly: true
        type: string
        description: Resource type
      location:
        type: string
        description: Resource location
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
    required:
    - location
    x-ms-azure-resource: true
  SecurityRulePropertiesFormat:
    properties:
      description:
        type: string
        description: Gets or sets a description for this rule. Restricted to 140 chars.
      protocol:
        type: string
        description: Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*).
        enum:
        - Tcp
        - Udp
        - '*'
        x-ms-enum:
          name: SecurityRuleProtocol
          modelAsString: true
      sourcePortRange:
        type: string
        description: Gets or sets Source Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
      destinationPortRange:
        type: string
        description: Gets or sets Destination Port or Range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports.
      sourceAddressPrefix:
        type: string
        description: 'Gets or sets source address prefix. CIDR or source IP range. Asterisk ''*'' can also be used to match all source IPs. Default tags such as ''VirtualNetwork'', ''AzureLoadBalancer'' and ''Internet'' can also be used. If this is an ingress rule, specifies where network traffic originates from. '
      destinationAddressPrefix:
        type: string
        description: 'Gets or sets destination address prefix. CIDR or source IP range. Asterisk ''*'' can also be used to match all source IPs. Default tags such as ''VirtualNetwork'', ''AzureLoadBalancer'' and ''Internet'' can also be used. '
      access:
        type: string
        description: Gets or sets network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'
        enum:
        - Allow
        - Deny
        x-ms-enum:
          name: SecurityRuleAccess
          modelAsString: true
      priority:
        type: integer
        format: int32
        description: Gets or sets the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.
      direction:
        type: string
        description: Gets or sets the direction of the rule.InBound or Outbound. The direction specifies if rule will be evaluated on incoming or outgoing traffic.
        enum:
        - Inbound
        - Outbound
        x-ms-enum:
          name: SecurityRuleDirection
          modelAsString: true
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    required:
    - protocol
    - sourceAddressPrefix
    - destinationAddressPrefix
    - access
    - direction
  NetworkSecurityGroupListResult:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NetworkSecurityGroup'
        description: Gets List of NetworkSecurityGroups in a resource group
      nextLink:
        type: string
        description: Gets the URL to get the next set of results.
    description: Response for ListNetworkSecurityGroups Api service call
  SubResource:
    properties:
      id:
        type: string
        description: Resource Id
    x-ms-azure-resource: true
  SecurityRule:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/SecurityRulePropertiesFormat'
      name:
        type: string
        description: Gets name of the resource that is unique within a resource group. This name can be used to access the resource
      etag:
        type: string
        description: A unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/SubResource'
    description: Network security rule
  NetworkSecurityGroupPropertiesFormat:
    properties:
      securityRules:
        type: array
        items:
          $ref: '#/definitions/SecurityRule'
        description: Gets or sets Security rules of network security group
      defaultSecurityRules:
        type: array
        items:
          $ref: '#/definitions/SecurityRule'
        description: Gets or sets Default security rules of network security group
      networkInterfaces:
        type: array
        items:
          $ref: '#/definitions/SubResource'
        description: Gets collection of references to Network Interfaces
      subnets:
        type: array
        items:
          $ref: '#/definitions/SubResource'
        description: Gets collection of references to subnets
      resourceGuid:
        type: string
        description: Gets or sets resource guid property of the network security group resource
      provisioningState:
        type: string
        description: Gets or sets Provisioning state of the PublicIP resource Updating/Deleting/Failed
    description: Network Security Group resource
  NetworkSecurityGroup:
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NetworkSecurityGroupPropertiesFormat'
      etag:
        type: string
        description: Gets a unique read-only string that changes whenever the resource is updated
    allOf:
    - $ref: '#/definitions/Resource'
    description: NetworkSecurityGroup resource
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: Client Api Version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'