Microsoft Azure
Microsoft Azure Firewalls API

The Firewalls API from Microsoft Azure — 7 operation(s) for firewalls.
Documentation GitHub OpenAPI
OpenAPI Specification

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Firewalls API
schemes:
- https
tags:
- name: Firewalls
paths:
  /subscriptions/{subscriptionId}/providers/PaloAltoNetworks.Cloudngfw/firewalls:
    get:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsListbysubscription
      description: List FirewallResource resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/FirewallResourceListResult'
        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:
        Firewalls_ListBySubscription_MaximumSet_Gen:
          $ref: ./examples/Firewalls_ListBySubscription_MaximumSet_Gen.json
        Firewalls_ListBySubscription_MinimumSet_Gen:
          $ref: ./examples/Firewalls_ListBySubscription_MinimumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Paloaltonetworks Cloudngfw Firewalls
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls:
    get:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsListbyresourcegroup
      description: List FirewallResource resources by resource group
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/FirewallResourceListResult'
        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:
        Firewalls_ListByResourceGroup_MaximumSet_Gen:
          $ref: ./examples/Firewalls_ListByResourceGroup_MaximumSet_Gen.json
        Firewalls_ListByResourceGroup_MinimumSet_Gen:
          $ref: ./examples/Firewalls_ListByResourceGroup_MinimumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}
  : get:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsGet
      description: Get a FirewallResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/FirewallResource'
        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:
        Firewalls_Get_MaximumSet_Gen:
          $ref: ./examples/Firewalls_Get_MaximumSet_Gen.json
        Firewalls_Get_MinimumSet_Gen:
          $ref: ./examples/Firewalls_Get_MinimumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname
    put:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsCreateorupdate
      description: Create a FirewallResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      - name: resource
        in: body
        required: true
        description: Resource create parameters.
        schema:
          $ref: '#/definitions/FirewallResource'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/FirewallResource'
        '201':
          description: Azure create operation completed successfully.
          schema:
            $ref: '#/definitions/FirewallResource'
        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:
        Firewalls_CreateOrUpdate_MaximumSet_Gen:
          $ref: ./examples/Firewalls_CreateOrUpdate_MaximumSet_Gen.json
        Firewalls_CreateOrUpdate_MinimumSet_Gen:
          $ref: ./examples/Firewalls_CreateOrUpdate_MinimumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname
    patch:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsUpdate
      description: Update a FirewallResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      - name: properties
        in: body
        required: true
        description: The resource properties to be updated.
        schema:
          $ref: '#/definitions/FirewallResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/FirewallResource'
        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:
        Firewalls_Update_MaximumSet_Gen:
          $ref: ./examples/Firewalls_Update_MaximumSet_Gen.json
        Firewalls_Update_MinimumSet_Gen:
          $ref: ./examples/Firewalls_Update_MinimumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname
    delete:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsDelete
      description: Delete a FirewallResource
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      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:
        Firewalls_Delete_MaximumSet_Gen:
          $ref: ./examples/Firewalls_Delete_MaximumSet_Gen.json
        Firewalls_Delete_MinimumSet_Gen:
          $ref: ./examples/Firewalls_Delete_MinimumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getGlobalRulestack
  : post:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsGetglobalrulestack
      description: Get Global Rulestack associated with the Firewall
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/GlobalRulestackInfo'
        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:
        Firewalls_getGlobalRulestack_MaximumSet_Gen:
          $ref: ./examples/Firewalls_getGlobalRulestack_MaximumSet_Gen.json
        Firewalls_getGlobalRulestack_MinimumSet_Gen:
          $ref: ./examples/Firewalls_getGlobalRulestack_MinimumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname Getglobalrulestack
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getLogProfile
  : post:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsGetlogprofile
      description: Log Profile for Firewall
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/LogSettings'
        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:
        Firewalls_getLogProfile_MaximumSet_Gen:
          $ref: ./examples/Firewalls_getLogProfile_MaximumSet_Gen.json
        Firewalls_getLogProfile_MinimumSet_Gen:
          $ref: ./examples/Firewalls_getLogProfile_MinimumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname Getlogprofile
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/getSupportInfo
  : post:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsGetsupportinfo
      description: support info for firewall.
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      - name: email
        in: query
        required: false
        description: email address on behalf of which this API called
        type: string
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/SupportInfo'
        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:
        Firewalls_getSupportInfo_MaximumSet_Gen:
          $ref: ./examples/Firewalls_getSupportInfo_MaximumSet_Gen.json
        Firewalls_getSupportInfo_MinimumSet_Gen:
          $ref: ./examples/Firewalls_getSupportInfo_MinimumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname Getsupportinfo
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/PaloAltoNetworks.Cloudngfw/firewalls/{firewallName}/saveLogProfile
  : post:
      tags:
      - Firewalls
      operationId: microsoftAzureFirewallsSavelogprofile
      description: Log Profile for Firewall
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/FirewallResource.firewallName'
      - name: logSettings
        in: body
        required: false
        schema:
          $ref: '#/definitions/LogSettings'
      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:
        Firewalls_saveLogProfile_MaximumSet_Gen:
          $ref: ./examples/Firewalls_saveLogProfile_MaximumSet_Gen.json
        Firewalls_saveLogProfile_MinimumSet_Gen:
          $ref: ./examples/Firewalls_saveLogProfile_MinimumSet_Gen.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Paloaltonetworks Cloudngfw Firewalls Firewallname Savelogprofile
definitions:
  StorageAccount:
    type: object
    properties:
      id:
        type: string
        description: Resource ID of storage account
      subscriptionId:
        type: string
        description: Subscription Id
      accountName:
        type: string
        description: Storage account name
    description: Storage Account configurations
  Azure.ResourceManager.UserAssignedIdentity:
    type: object
    properties:
      clientId:
        type: string
        description: The active directory client identifier for this principal.
      principalId:
        type: string
        description: The active directory identifier for this principal.
    description: A managed identity assigned by the user.
  NetworkProfile:
    type: object
    properties:
      vnetConfiguration:
        $ref: '#/definitions/VnetConfiguration'
        description: Vnet configurations
      vwanConfiguration:
        $ref: '#/definitions/VwanConfiguration'
        description: Vwan configurations
      networkType:
        $ref: '#/definitions/NetworkType'
        description: vnet or vwan, cannot be updated
      publicIps:
        type: array
        items:
          $ref: '#/definitions/IPAddress'
        x-ms-identifiers: []
        x-cadl-name: IPAddress[]
        description: List of IPs associated with the Firewall
      enableEgressNat:
        $ref: '#/definitions/EgressNat'
        description: Enable egress NAT, enabled by default
      egressNatIp:
        type: array
        items:
          $ref: '#/definitions/IPAddress'
        x-ms-identifiers: []
        x-cadl-name: IPAddress[]
        description: Egress nat IP to use
      trustedRanges:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: Non-RFC 1918 address
      privateSourceNatRulesDestination:
        type: array
        items:
          type: string
        x-cadl-name: string[]
        description: Array of ipv4 destination address for which source NAT is to be performed
    description: Network settings for Firewall
    required:
    - networkType
    - publicIps
    - enableEgressNat
  Azure.ResourceManager.ManagedIdentityType:
    type: string
    description: The kind of managed identity assigned to this resource.
    enum:
    - None
    - SystemAssigned
    - UserAssigned
    - SystemAssigned,UserAssigned
    x-ms-enum:
      name: ManagedIdentityType
      modelAsString: true
      values:
      - name: None
        value: None
      - name: SystemAssigned
        value: SystemAssigned
      - name: UserAssigned
        value: UserAssigned
      - name: SystemAndUserAssigned
        value: SystemAssigned,UserAssigned
  NetworkType:
    type: string
    description: NetworkType Enum
    enum:
    - VNET
    - VWAN
    x-ms-enum:
      name: NetworkType
      modelAsString: true
  FirewallResourceUpdateProperties:
    type: object
    properties:
      panEtag:
        type: string
        description: panEtag info
      networkProfile:
        $ref: '#/definitions/NetworkProfile'
        description: Network settings
      isPanoramaManaged:
        $ref: '#/definitions/BooleanEnum'
        description: 'Panorama Managed: Default is False. Default will be CloudSec managed'
      isStrataCloudManaged:
        $ref: '#/definitions/BooleanEnum'
        description: 'Strata Cloud Managed: Default is False. Default will be CloudSec managed'
      panoramaConfig:
        $ref: '#/definitions/PanoramaConfig'
        description: Panorama Configuration
      strataCloudManagerConfig:
        $ref: '#/definitions/StrataCloudManagerConfig'
        description: Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected.
      associatedRulestack:
        $ref: '#/definitions/RulestackDetails'
        description: Associated Rulestack
      dnsSettings:
        $ref: '#/definitions/DNSSettings'
        description: DNS settings for Firewall
      frontEndSettings:
        type: array
        items:
          $ref: '#/definitions/FrontendSetting'
        x-ms-identifiers: []
        x-cadl-name: FrontendSetting[]
        description: Frontend settings for Firewall
      planData:
        $ref: '#/definitions/PlanData'
        description: Billing plan information.
      marketplaceDetails:
        $ref: '#/definitions/MarketplaceDetails'
        description: Marketplace details
    description: The updatable properties of the FirewallResource.
  LogDestination:
    type: object
    properties:
      storageConfigurations:
        $ref: '#/definitions/StorageAccount'
        description: Storage account configurations
      eventHubConfigurations:
        $ref: '#/definitions/EventHub'
        description: Event Hub configurations
      monitorConfigurations:
        $ref: '#/definitions/MonitorLog'
        description: Monitor Log configurations
    description: Log Destination
  ProtocolType:
    type: string
    description: Protocol Enum
    enum:
    - TCP
    - UDP
    x-ms-enum:
      name: ProtocolType
      modelAsString: true
  MarketplaceSubscriptionStatus:
    type: string
    description: Marketplace Subscription Status
    enum:
    - PendingFulfillmentStart
    - Subscribed
    - Suspended
    - Unsubscribed
    - NotStarted
    - FulfillmentRequested
    x-ms-enum:
      name: MarketplaceSubscriptionStatus
      modelAsString: true
  FrontendSetting:
    type: object
    properties:
      name:
        type: string
        description: Settings name
      protocol:
        $ref: '#/definitions/ProtocolType'
        description: Protocol Type
      frontendConfiguration:
        $ref: '#/definitions/EndpointConfiguration'
        description: Frontend configurations
      backendConfiguration:
        $ref: '#/definitions/EndpointConfiguration'
        description: Backend configurations
    description: Frontend setting for Firewall
    required:
    - name
    - protocol
    - frontendConfiguration
    - backendConfiguration
  VwanConfiguration:
    type: object
    properties:
      networkVirtualApplianceId:
        type: string
        description: 'Network Virtual Appliance resource ID '
      vHub:
        $ref: '#/definitions/IPAddressSpace'
        description: vHub Address
      trustSubnet:
        $ref: '#/definitions/IPAddressSpace'
        description: Trust Subnet
      unTrustSubnet:
        $ref: '#/definitions/IPAddressSpace'
        description: Untrust Subnet
      ipOfTrustSubnetForUdr:
        $ref: '#/definitions/IPAddress'
        description: IP of trust subnet for UDR
    description: VwanInfo for Firewall Networking
    required:
    - vHub
  PanoramaConfig:
    type: object
    properties:
      configString:
        type: string
        description: Base64 encoded string representing Panorama parameters to be used by Firewall to connect to Panorama. This string is generated via azure plugin in Panorama
      vmAuthKey:
        type: string
        description: VM auth key for panorama connectivity
        readOnly: true
      panoramaServer:
        type: string
        description: Primary Panorama Server IP address value in dotted format for IPv4
        readOnly: true
      panoramaServer2:
        type: string
        description: Secondary Panorama Server IP address value in dotted format for IPv4
        readOnly: true
      dgName:
        type: string
        description: Panorama Device Group to join
        readOnly: true
      tplName:
        type: string
        description: Panorama Template Stack to join - (Once configured we can not edit the value)
        readOnly: true
      cgName:
        type: string
        description: Panorama Collector Group to join - (Once configured we can not edit the value)
        readOnly: true
      hostName:
        type: string
        description: Resource name(may be unique) for PN admin
        readOnly: true
    description: Panorama Config
    required:
    - configString
  LogType:
    type: string
    description: Possible log types
    enum:
    - TRAFFIC
    - THREAT
    - DECRYPTION
    - WILDFIRE
    - DLP
    - AUDIT
    x-ms-enum:
      name: LogType
      modelAsString: true
  EnabledDNSType:
    type: string
    description: Enabled DNS type values
    enum:
    - CUSTOM
    - AZURE
    x-ms-enum:
      name: EnabledDNSType
      modelAsString: true
  MonitorLog:
    type: object
    properties:
      id:
        type: string
        description: Resource ID of MonitorLog
      subscriptionId:
        type: string
        description: Subscription Id
      workspace:
        type: string
        description: MonitorLog workspace
      primaryKey:
        type: string
        description: Primary Key value for Monitor
      secondaryKey:
        type: string
        description: Secondary Key value for Monitor
    description: MonitorLog configurations
  EgressNat:
    type: string
    description: Egress NAT
    enum:
    - DISABLED
    - ENABLED
    x-ms-enum:
      name: EgressNat
      modelAsString: true
  PlanData:
    type: object
    properties:
      usageType:
        $ref: '#/definitions/UsageType'
        description: different usage type like PAYG/COMMITTED
      billingCycle:
        $ref: '#/definitions/BillingCycle'
        description: different billing cycles like MONTHLY/WEEKLY
      planId:
        type: string
        description: plan id as published by Liftr.PAN
        maxLength: 50
      effectiveDate:
        type: string
        format: date-time
        description: date when plan was applied
        readOnly: true
    description: Billing plan information.
    required:
    - billingCycle
    - planId
  BillingCycle:
    type: string
    description: Billing cycle
    enum:
    - WEEKLY
    - MONTHLY
    x-ms-enum:
      name: BillingCycle
      modelAsString: true
  DNSSettings:
    type: object
    properties:
      enableDnsProxy:
        $ref: '#/definitions/DNSProxy'
        description: Enable DNS proxy, disabled by default
      enabledDnsType:
        $ref: '#/definitions/EnabledDNSType'
        description: Enabled DNS proxy type, disabled by default
      dnsServers:
        type: array
        items:
          $ref: '#/definitions/IPAddress'
        x-ms-identifiers: []
        x-cadl-name: IPAddress[]
        description: List of IPs associated with the Firewall
    description: DNS Proxy settings for Firewall
  StrataCloudManagerConfig:
    type: object
    properties:
      cloudManagerName:
        type: string
        description: Strata Cloud Manager name which is intended to manage the policy for this firewall.
    description: This field is only present if Strata Cloud Manager is managing the policy for this firewall
    required:
    - cloudManagerName
  LogSettings:
    type: object
    properties:
      logType:
        $ref: '#/definitions/LogType'
        description: One of possible log type
      logOption:
        $ref: '#/definitions/LogOption'
        description: Log option SAME/INDIVIDUAL
      applicationInsights:
        $ref: '#/definitions/ApplicationInsights'
        description: Application Insight details
      commonDestination:
        $ref: '#/definitions/LogDestination'
        description: Common destination configurations
      trafficLogDestination:
        $ref: '#/definitions/LogDestination'
        description: Traffic destination configurations
      threatLogDestination:
        $ref: '#/definitions/LogDestination'
        description: Threat destination configurations
      decryptLogDestination:
        $ref: '#/definitions/LogDestination'
        description: Decrypt destination configurations
    description: Log Settings for Firewall
  EventHub:
    type: object
    properties:
      id:
        type: string
        description: Resource ID of EventHub
      subscriptionId:
        type: string
        description: Subscription Id
      name:
        type: string
        description: EventHub name
      nameSpace:
        type: string
        description: EventHub namespace
      policyName:
        type: string
        description: EventHub policy name
    description: EventHub configurations
  FirewallResourceListResult:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/FirewallResource'
        x-cadl-name: FirewallResource[]
        description: The items on this page
      nextLink:
        type: string
        description: The link to the next page of items
    description: The response of a FirewallResource list operation.
    required:
    - value
  FirewallDeploymentProperties:
    type: object
    properties:
      panEtag:
        type: string
        description: panEtag info
      networkProfile:
        $ref: '#/definitions/NetworkProfile'
        description: Network settings
      isPanoramaManaged:
        $ref: '#/definitions/BooleanEnum'
        description: 'Panorama Managed: Default is False. Default will be CloudSec managed'
      isStrataCloudManaged:
        $ref: '#/definitions/BooleanEnum'
        description: 'Strata Cloud Managed: Default is False. Default will be CloudSec managed'
      panoramaConfig:
        $ref: '#/definitions/PanoramaConfig'
        description: Panorama Configuration
      strataCloudManagerConfig:
        $ref: '#/definitions/StrataCloudManagerConfig'
        description: Strata Cloud Manager Configuration, only applicable if Strata Cloud Manager is selected.
      associatedRulestack:
        $ref: '#/definitions/RulestackDetails'
        description: Associated Rulestack
      dnsSettings:
        $ref: '#/definitions/DNSSettings'
        description: DNS settings for Firewall
      frontEndSettings:
        type: array
        items:
          $ref: '#/definitions/FrontendSetting'
        x-ms-identifiers: []
        x-cadl-name: FrontendSetting[]
        description: Frontend settings for Firewall
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning state of the resource.
        readOnly: true
      planData:
        $ref: '#/definitions/PlanData'
        description: Billing plan information.
      marketplaceDetails:
        $ref: '#/definitions/MarketplaceDetails'
        description: Marketplace details
    description: Properties specific to the Firewall resource deployment.
    required:
    - networkProfile
    - dnsSettings
    - planData
    - marketplaceDetails
  SupportInfo:
    type: object
    properties:
      productSku:
        type: string
        description: product SKU associated with given resource
      productSerial:
        type: string
        description: product Serial associated with given resource
      accountRegistered:
        $ref: '#/definitions/BooleanEnum'
        description: account registered in Customer Support Portal
      accountId:
        type: string
        description: Support account associated with given resource
      userDomainSupported:
        $ref: '#/definitions/BooleanEnum'
        description: user domain is supported in Customer Support Portal
      userRegistered:
        $ref: '#/definitions/BooleanEnum'
        description: user registered in Customer Support Portal
      freeTrial:
        $ref: '#/definitions/BooleanEnum'
        description: Product usage is in free trial period
      freeTrialDaysLeft:
        type: integer
        format: int32
        description: Free trial days remaining
      freeTrialCreditLeft:
        type: integer
        format: int32
        description: Free trial credit remaining
      helpURL:
        type: string
        description: URL for paloaltonetworks live community
      supportURL:
        type: string
        description: URL for paloaltonetworks Customer Service Portal
      registerURL:
        type: string
        description: URL for registering product in paloaltonetworks Customer Service Portal
    description: Support information for the resource
  GlobalRulestackInfo:
    type: object
    properties:
      azureId:
        type: string
        description: rulestack description
    description: PAN Rulestack Describe Object
    required:
    - azureId
  IPAddress:
    type: object
    properties:
      resourceId:
        type: string
        description: Resource Id
      address:
        type: string
        description: Address value
    description: IP Address
  IPAddressSpace:
    type: object
    properties:
      resourceId:
        type: string
        description: Resource Id
      addressSpace:
        type: string
        description: Address Space
    description: IP Address Space
  Rulesta

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-firewalls-api-openapi.yml
Microsoft Azure Firewalls API

Documentation

Specifications

Other Resources

OpenAPI Specification
