swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector NspAccessRules API
schemes:
- https
tags:
- name: NspAccessRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules/{accessRuleName}
  : parameters:
    - $ref: ./network.json#/parameters/SubscriptionIdParameter
    - $ref: '#/parameters/ResourceGroupNameParameter'
    - $ref: '#/parameters/NetworkSecurityPerimeterNameParameter'
    - $ref: '#/parameters/ProfileNameParameter'
    - $ref: '#/parameters/AccessRuleNameParameter'
    - $ref: ./network.json#/parameters/ApiVersionParameter
    get:
      tags:
      - NspAccessRules
      operationId: microsoftAzureNspaccessrulesGet
      description: Gets the specified NSP access rule by name.
      responses:
        '200':
          description: OK - Returns information about the NSP access rule.
          schema:
            $ref: '#/definitions/NspAccessRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspAccessRuleGet:
          $ref: ./examples/NspAccessRuleGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Profiles Profilename Accessrules Accessrulename
    put:
      tags:
      - NspAccessRules
      operationId: microsoftAzureNspaccessrulesCreateorupdate
      description: Creates or updates a network access rule.
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/NspAccessRule'
        description: Parameters that hold the NspAccessRule resource to be created/updated.
      responses:
        '200':
          description: Updated - Existing access rule is updated. Returns the resource.
          schema:
            $ref: '#/definitions/NspAccessRule'
        '201':
          description: Create - Returns the NspAccessRule resource created.
          schema:
            $ref: '#/definitions/NspAccessRule'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspAccessRulePut:
          $ref: ./examples/NspAccessRulePut.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Profiles Profilename Accessrules Accessrulename
    delete:
      tags:
      - NspAccessRules
      operationId: microsoftAzureNspaccessrulesDelete
      description: Deletes an NSP access rule.
      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:
        NspAccessRulesDelete:
          $ref: ./examples/NspAccessRuleDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Profiles Profilename Accessrules Accessrulename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{profileName}/accessRules
  : get:
      tags:
      - NspAccessRules
      operationId: microsoftAzureNspaccessrulesList
      description: Lists the NSP access rules in the specified NSP profile.
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./network.json#/parameters/SubscriptionIdParameter
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/NetworkSecurityPerimeterNameParameter'
      - $ref: '#/parameters/ProfileNameParameter'
      - $ref: ./network.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/ListTopParameter'
      - $ref: '#/parameters/ListSkipTokenParameter'
      responses:
        '200':
          description: OK - Returns the list of NSP access rules.
          schema:
            $ref: '#/definitions/NspAccessRuleListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ./network.json#/definitions/CloudError
      x-ms-examples:
        NspAccessRulesList:
          $ref: ./examples/NspAccessRuleList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Network Networksecurityperimeters Networksecurityperimetername Profiles Profilename Accessrules
definitions:
  NspAccessRuleListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/NspAccessRule'
        description: Gets a page of NSP access rule
      nextLink:
        type: string
        description: Gets the URL to get the next page of results.
    description: Result of the request to list NSP access rules. Contains a list of NSP access rules and a URL link to get the next set of results.
  NspAccessRuleProperties:
    type: object
    properties:
      provisioningState:
        readOnly: true
        $ref: '#/definitions/NSPProvisioningState'
        description: The provisioning state of the scope assignment resource.
      direction:
        type: string
        enum:
        - Inbound
        - Outbound
        x-ms-enum:
          name: AccessRuleDirection
          modelAsString: true
        description: Direction that specifies whether the access rules is inbound/outbound.
      addressPrefixes:
        type: array
        items:
          type: string
        description: Inbound address prefixes (IPv4/IPv6)
      fullyQualifiedDomainNames:
        type: array
        items:
          type: string
        description: Outbound rules fully qualified domain name format.
      subscriptions:
        type: array
        items:
          x-ms-client-flatten: true
          $ref: '#/definitions/SubscriptionId'
        description: List of subscription ids
      networkSecurityPerimeters:
        readOnly: true
        type: array
        items:
          x-ms-client-flatten: true
          $ref: '#/definitions/PerimeterBasedAccessRule'
        description: Rule specified by the perimeter id.
      emailAddresses:
        type: array
        items:
          type: string
        description: Outbound rules email address format.
      phoneNumbers:
        type: array
        items:
          type: string
        description: Outbound rules phone number format.
    description: Properties of NSP access rule.
  NSPProvisioningState:
    type: string
    readOnly: true
    description: The current provisioning state.
    enum:
    - Succeeded
    - Creating
    - Updating
    - Deleting
    - Accepted
    - Failed
    x-ms-enum:
      name: nspProvisioningState
      modelAsString: true
  SubscriptionId:
    type: object
    properties:
      id:
        type: string
        description: Subscription id in the ARM id format.
  PerimeterBasedAccessRule:
    type: object
    properties:
      id:
        readOnly: true
        type: string
        description: NSP id in the ARM id format.
      perimeterGuid:
        readOnly: true
        type: string
        description: Resource guid of the NSP supplied.
      location:
        readOnly: true
        type: string
        description: Location of the NSP supplied.
  NspAccessRule:
    type: object
    properties:
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/NspAccessRuleProperties'
        description: Properties of the NSP access rule.
      name:
        type: string
        description: The name of the access rule that is unique within a profile. This name can be used to access the resource.
      id:
        readOnly: true
        type: string
        description: NSP access rule identifier.
      type:
        readOnly: true
        type: string
        description: Resource type.
    allOf:
    - $ref: ./network.json#/definitions/Resource
    description: The NSP access rule resource
parameters:
  AccessRuleNameParameter:
    name: accessRuleName
    in: path
    required: true
    type: string
    description: The name of the NSP access rule.
    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
  NetworkSecurityPerimeterNameParameter:
    name: networkSecurityPerimeterName
    in: path
    required: true
    type: string
    description: The name of the network security perimeter.
    x-ms-parameter-location: method
  ProfileNameParameter:
    name: profileName
    in: path
    required: true
    type: string
    description: The name of the NSP profile.
    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
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'