Microsoft Azure PreRules API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PreRules API
schemes:
- https
tags:
- name: PreRules
paths:
  /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules:
    get:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesList
      description: List PreRulesResource resources by Tenant
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/PreRulesResourceListResult'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        PreRules_List_MaximumSet_Gen:
          $ref: ./examples/PreRules_List_MaximumSet_Gen.json
        PreRules_List_MinimumSet_Gen:
          $ref: ./examples/PreRules_List_MinimumSet_Gen.json
      summary: Microsoft Azure Get Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules
  /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}:
    get:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesGet
      description: Get a PreRulesResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      - $ref: '#/parameters/PreRulesResource.priority'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/PreRulesResource'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PreRules_Get_MaximumSet_Gen:
          $ref: ./examples/PreRules_Get_MaximumSet_Gen.json
        PreRules_Get_MinimumSet_Gen:
          $ref: ./examples/PreRules_Get_MinimumSet_Gen.json
      summary: Microsoft Azure Get Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules Priority
    put:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesCreateorupdate
      description: Create a PreRulesResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      - $ref: '#/parameters/PreRulesResource.priority'
      - name: resource
        in: body
        required: true
        description: Resource create parameters.
        schema:
          $ref: '#/definitions/PreRulesResource'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/PreRulesResource'
        '201':
          description: Azure create operation completed successfully.
          schema:
            $ref: '#/definitions/PreRulesResource'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      x-ms-examples:
        PreRules_CreateOrUpdate_MaximumSet_Gen:
          $ref: ./examples/PreRules_CreateOrUpdate_MaximumSet_Gen.json
        PreRules_CreateOrUpdate_MinimumSet_Gen:
          $ref: ./examples/PreRules_CreateOrUpdate_MinimumSet_Gen.json
      summary: Microsoft Azure Put Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules Priority
    delete:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesDelete
      description: Delete a PreRulesResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      - $ref: '#/parameters/PreRulesResource.priority'
      responses:
        '200':
          description: Resource deleted successfully.
        '202':
          description: Resource deletion accepted.
        '204':
          description: Resource deleted successfully.
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      x-ms-examples:
        PreRules_Delete_MaximumSet_Gen:
          $ref: ./examples/PreRules_Delete_MaximumSet_Gen.json
        PreRules_Delete_MinimumSet_Gen:
          $ref: ./examples/PreRules_Delete_MinimumSet_Gen.json
      summary: Microsoft Azure Delete Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules Priority
  /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/getCounters:
    post:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesGetcounters
      description: Get counters
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      - $ref: '#/parameters/PreRulesResource.priority'
      - name: firewallName
        in: query
        required: false
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RuleCounter'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PreRules_getCounters_MaximumSet_Gen:
          $ref: ./examples/PreRules_getCounters_MaximumSet_Gen.json
        PreRules_getCounters_MinimumSet_Gen:
          $ref: ./examples/PreRules_getCounters_MinimumSet_Gen.json
      summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules Priority Getcounters
  /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/refreshCounters:
    post:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesRefreshcounters
      description: Refresh counters
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      - $ref: '#/parameters/PreRulesResource.priority'
      - name: firewallName
        in: query
        required: false
        type: string
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PreRules_refreshCounters_MaximumSet_Gen:
          $ref: ./examples/PreRules_refreshCounters_MaximumSet_Gen.json
        PreRules_refreshCounters_MinimumSet_Gen:
          $ref: ./examples/PreRules_refreshCounters_MinimumSet_Gen.json
      summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules Priority Refreshcounters
  /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/preRules/{priority}/resetCounters:
    post:
      tags:
      - PreRules
      operationId: microsoftAzurePrerulesResetcounters
      description: Reset counters
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName'
      - $ref: '#/parameters/PreRulesResource.priority'
      - name: firewallName
        in: query
        required: false
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/RuleCounterReset'
        default:
          description: Common error response for all Azure Resource Manager APIs to return error details for failed operations.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        PreRules_resetCounters_MaximumSet_Gen:
          $ref: ./examples/PreRules_resetCounters_MaximumSet_Gen.json
        PreRules_resetCounters_MinimumSet_Gen:
          $ref: ./examples/PreRules_resetCounters_MinimumSet_Gen.json
      summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Prerules Priority Resetcounters
definitions:
  DestinationAddr:
    type: object
    properties:
      cidrs:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: special value 'any'
      countries:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: list of countries
      feeds:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: list of feeds
      prefixLists:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: prefix list
      fqdnLists:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: fqdn list
    description: destination address
  Category:
    type: object
    properties:
      urlCustom:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: custom URL
      feeds:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: feed list
    description: URL/EDL to match
    required:
    - urlCustom
    - feeds
  RuleEntry:
    type: object
    properties:
      etag:
        type: string
        description: etag info
      ruleName:
        type: string
        description: rule name
      priority:
        type: integer
        format: int32
        readOnly: true
      description:
        type: string
        description: rule description
      ruleState:
        $ref: '#/definitions/StateEnum'
        description: state of this rule
      source:
        $ref: '#/definitions/SourceAddr'
        description: source address
      negateSource:
        $ref: '#/definitions/BooleanEnum'
        description: cidr should not be 'any'
      destination:
        $ref: '#/definitions/DestinationAddr'
        description: destination address
      negateDestination:
        $ref: '#/definitions/BooleanEnum'
        description: cidr should not be 'any'
      applications:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: array of rule applications
      category:
        $ref: '#/definitions/Category'
        description: rule category
      protocol:
        type: string
        description: any, application-default, TCP:number, UDP:number
        default: application-default
      protocolPortList:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: prot port list
      inboundInspectionCertificate:
        type: string
        description: inbound Inspection Certificate
      auditComment:
        type: string
        description: rule comment
      actionType:
        $ref: '#/definitions/ActionEnum'
        description: rule action
      enableLogging:
        $ref: '#/definitions/StateEnum'
        description: enable or disable logging
      decryptionRuleType:
        $ref: '#/definitions/DecryptionRuleTypeEnum'
        description: enable or disable decryption
      tags:
        type: array
        items:
          $ref: '#/definitions/TagInfo'
        x-ms-identifiers: []
        x-cadl-name: TagInfo[]
        description: tag for rule
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning state of the resource.
        readOnly: true
    description: definition of rule
    required:
    - ruleName
  PreRulesResource:
    type: object
    properties:
      properties:
        $ref: '#/definitions/RuleEntry'
        description: The resource-specific properties for this resource.
        x-ms-mutability:
        - read
        - create
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData
        description: System metadata for this resource.
        readOnly: true
    description: PreRulestack rule list
    required:
    - properties
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource
  StateEnum:
    type: string
    description: Enabled or Disabled Enum
    enum:
    - DISABLED
    - ENABLED
    x-ms-enum:
      name: StateEnum
      modelAsString: true
  TagInfo:
    type: object
    properties:
      key:
        type: string
        description: tag name
      value:
        type: string
        description: tag value
    description: Tag
    required:
    - key
    - value
  ProvisioningState:
    type: string
    description: Provisioning state of the firewall resource.
    enum:
    - Accepted
    - Creating
    - Updating
    - Deleting
    - Succeeded
    - Failed
    - Canceled
    - Deleted
    - NotSpecified
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  RuleCounter:
    type: object
    properties:
      priority:
        type: string
        description: priority number
      ruleStackName:
        type: string
        description: rule Stack Name
      ruleListName:
        type: string
        description: rule list name
      firewallName:
        type: string
        description: firewall name
      ruleName:
        type: string
        description: rule name
      hitCount:
        type: integer
        format: int32
        description: hit count
      appSeen:
        $ref: '#/definitions/AppSeenData'
        description: apps seen
      timestamp:
        type: string
        format: date-time
        description: timestamp of response
      requestTimestamp:
        type: string
        format: date-time
        description: timestamp of request
      lastUpdatedTimestamp:
        type: string
        format: date-time
        description: last updated timestamp
    description: Rule counter
    required:
    - priority
    - ruleName
  DecryptionRuleTypeEnum:
    type: string
    enum:
    - SSLOutboundInspection
    - SSLInboundInspection
    - None
    x-ms-enum:
      name: DecryptionRuleTypeEnum
      modelAsString: true
  ActionEnum:
    type: string
    enum:
    - Allow
    - DenySilent
    - DenyResetServer
    - DenyResetBoth
    x-ms-enum:
      name: ActionEnum
      modelAsString: true
  BooleanEnum:
    type: string
    description: Boolean Enum
    enum:
    - 'TRUE'
    - 'FALSE'
    x-ms-enum:
      name: BooleanEnum
      modelAsString: true
  SourceAddr:
    type: object
    properties:
      cidrs:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: special value 'any'
      countries:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: list of countries
      feeds:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: list of feeds
      prefixLists:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: prefix list
    description: Address properties
  AppSeenInfo:
    type: object
    properties:
      title:
        type: string
        description: title
      category:
        type: string
        description: category
      subCategory:
        type: string
        description: subCategory
      risk:
        type: string
        description: risk
      tag:
        type: string
        description: tag
      technology:
        type: string
        description: technology
      standardPorts:
        type: string
        description: standardPorts
    description: Definition for App Seen
    required:
    - title
    - category
    - subCategory
    - risk
    - tag
    - technology
    - standardPorts
  AppSeenData:
    type: object
    properties:
      count:
        type: integer
        format: int32
        description: number of rows
      appSeenList:
        type: array
        items:
          $ref: '#/definitions/AppSeenInfo'
        x-ms-identifiers: []
        x-cadl-name: AppSeenInfo[]
        description: array of appSeen
    description: Data Type for App Seen
    required:
    - count
    - appSeenList
  PreRulesResourceListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/PreRulesResource'
        x-cadl-name: PreRulesResource[]
        description: The items on this page
      nextLink:
        type: string
        description: The link to the next page of items
    description: The response of a PreRulesResource list operation.
    required:
    - value
  RuleCounterReset:
    type: object
    properties:
      priority:
        type: string
        description: priority number
        readOnly: true
      ruleStackName:
        type: string
        description: rule Stack Name
      ruleListName:
        type: string
        description: rule list name
      firewallName:
        type: string
        description: firewall name
      ruleName:
        type: string
        description: rule name
    description: Rule counter reset
parameters:
  GlobalRulestackResource.globalRulestackName:
    name: globalRulestackName
    in: path
    required: true
    description: GlobalRulestack resource name
    type: string
    x-ms-parameter-location: method
  PreRulesResource.priority:
    name: priority
    in: path
    required: true
    description: Pre Rule priority
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'