Microsoft Azure SecurityRules API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Security Rules API
tags:
- name: SecurityRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}
  : delete:
      tags:
      - SecurityRules
      operationId: microsoftAzureSecurityrulesDelete
      description: The delete network security rule operation deletes the specified network security rule.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkSecurityGroupName
        in: path
        required: true
        description: The name of the network security group.
        schema:
          type: string
      - name: securityRuleName
        in: path
        required: true
        description: The name of the security rule.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/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 Securityrules Securityrulename
    get:
      tags:
      - SecurityRules
      operationId: microsoftAzureSecurityrulesGet
      description: The Get NetworkSecurityRule operation retrieves information about the specified network security rule.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkSecurityGroupName
        in: path
        required: true
        description: The name of the network security group.
        schema:
          type: string
      - name: securityRuleName
        in: path
        required: true
        description: The name of the security rule.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRule'
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups Networksecuritygroupname Securityrules Securityrulename
    put:
      tags:
      - SecurityRules
      operationId: microsoftAzureSecurityrulesCreateorupdate
      description: The Put network security rule operation creates/updates a security rule in the specified network security group
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkSecurityGroupName
        in: path
        required: true
        description: The name of the network security group.
        schema:
          type: string
      - name: securityRuleName
        in: path
        required: true
        description: The name of the security rule.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRule'
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRule'
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups Networksecuritygroupname Securityrules Securityrulename
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityRule'
        description: Parameters supplied to the create/update network security rule operation
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules
  : get:
      tags:
      - SecurityRules
      operationId: microsoftAzureSecurityrulesList
      description: The List network security rule operation retrieves all the security rules in a network security group.
      parameters:
      - name: resourceGroupName
        in: path
        required: true
        description: The name of the resource group.
        schema:
          type: string
      - name: networkSecurityGroupName
        in: path
        required: true
        description: The name of the network security group.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRuleListResult'
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecuritygroups Networksecuritygroupname Securityrules
components:
  schemas:
    SubResource:
      properties:
        id:
          type: string
          description: Resource Id
      x-ms-azure-resource: true
    SecurityRule:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/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: '#/components/schemas/SubResource'
      description: Network security rule
    SecurityRuleListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/SecurityRule'
          description: Gets security rules in a network security group
        nextLink:
          type: string
          description: Gets the URL to get the next set of results.
      description: Response for ListSecurityRule Api service callRetrieves all security rules that belongs to a network security group
    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
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: Client Api Version.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'