swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector GlobalRulestack API schemes: - https tags: - name: GlobalRulestack paths: /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks: get: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackList description: List GlobalRulestackResource resources by Tenant parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/GlobalRulestackResourceListResult' 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: GlobalRulestack_List_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_List_MaximumSet_Gen.json GlobalRulestack_List_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_List_MinimumSet_Gen.json summary: Microsoft Azure Get Providers Paloaltonetworks Cloudngfw Globalrulestacks /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}: get: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackGet description: Get a GlobalRulestackResource 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/GlobalRulestackResource' 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: GlobalRulestack_Get_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_Get_MaximumSet_Gen.json GlobalRulestack_Get_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_Get_MinimumSet_Gen.json summary: Microsoft Azure Get Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname put: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackCreateorupdate description: Create a GlobalRulestackResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: resource in: body required: true description: Resource create parameters. schema: $ref: '#/definitions/GlobalRulestackResource' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/GlobalRulestackResource' '201': description: Azure create operation completed successfully. schema: $ref: '#/definitions/GlobalRulestackResource' 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: GlobalRulestack_CreateOrUpdate_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_CreateOrUpdate_MaximumSet_Gen.json GlobalRulestack_CreateOrUpdate_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_CreateOrUpdate_MinimumSet_Gen.json summary: Microsoft Azure Put Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname patch: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackUpdate description: Update a GlobalRulestackResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: properties in: body required: true description: The resource properties to be updated. schema: $ref: '#/definitions/GlobalRulestackResourceUpdate' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/GlobalRulestackResource' 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: GlobalRulestack_Update_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_Update_MaximumSet_Gen.json GlobalRulestack_Update_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_Update_MinimumSet_Gen.json summary: Microsoft Azure Patch Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname delete: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackDelete description: Delete a GlobalRulestackResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' 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: GlobalRulestack_Delete_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_Delete_MaximumSet_Gen.json GlobalRulestack_Delete_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_Delete_MinimumSet_Gen.json summary: Microsoft Azure Delete Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/commit: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackCommit description: Commit rulestack configuration parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' responses: '202': description: The request has been received but not yet acted upon. 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: location x-ms-long-running-operation: true x-ms-examples: GlobalRulestack_commit_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_commit_MaximumSet_Gen.json GlobalRulestack_commit_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_commit_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Commit /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/getChangeLog: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackGetchangelog description: Get changelog parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Changelog' 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: GlobalRulestack_getChangeLog_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_getChangeLog_MaximumSet_Gen.json GlobalRulestack_getChangeLog_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_getChangeLog_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Getchangelog /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listAdvancedSecurityObjects: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackListadvancedsecurityobjects description: Get the list of advanced security objects parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: skip in: query required: false type: string - name: top in: query required: false type: integer format: int32 - name: type in: query required: true type: string enum: - urlCustom - feeds x-ms-enum: name: AdvSecurityObjectTypeEnum modelAsString: true responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/advSecurityObjectListResponse' 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: GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_listAdvancedSecurityObjects_MaximumSet_Gen.json GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_listAdvancedSecurityObjects_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Listadvancedsecurityobjects /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listAppIds: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackListappids description: List of AppIds for GlobalRulestack ApiVersion parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: appIdVersion in: query required: false type: string - name: appPrefix in: query required: false type: string - name: skip in: query required: false type: string - name: top in: query required: false type: integer format: int32 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ListAppIdResponse' 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: GlobalRulestack_listAppIds_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_listAppIds_MaximumSet_Gen.json GlobalRulestack_listAppIds_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_listAppIds_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Listappids /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listCountries: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackListcountries description: List of countries for Rulestack parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: skip in: query required: false type: string - name: top in: query required: false type: integer format: int32 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/CountriesResponse' 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: GlobalRulestack_listCountries_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_listCountries_MaximumSet_Gen.json GlobalRulestack_listCountries_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_listCountries_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Listcountries /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listFirewalls: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackListfirewalls description: List of Firewalls associated with Rulestack parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/ListFirewallsResponse' 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: GlobalRulestack_listFirewalls_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_listFirewalls_MaximumSet_Gen.json GlobalRulestack_listFirewalls_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_listFirewalls_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Listfirewalls /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listPredefinedUrlCategories: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackListpredefinedurlcategories description: List predefined URL categories for rulestack parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: skip in: query required: false type: string - name: top in: query required: false type: integer format: int32 responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PredefinedUrlCategoriesResponse' 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: GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_listPredefinedUrlCategories_MaximumSet_Gen.json GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_listPredefinedUrlCategories_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Listpredefinedurlcategories /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/listSecurityServices: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackListsecurityservices description: List the security services for rulestack parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' - name: skip in: query required: false type: string - name: top in: query required: false type: integer format: int32 - name: type in: query required: true type: string enum: - antiSpyware - antiVirus - ipsVulnerability - urlFiltering - fileBlocking - dnsSubscription x-ms-enum: name: SecurityServicesTypeEnum modelAsString: true responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/securityServicesResponse' 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: GlobalRulestack_listSecurityServices_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_listSecurityServices_MaximumSet_Gen.json GlobalRulestack_listSecurityServices_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_listSecurityServices_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Listsecurityservices /providers/PaloAltoNetworks.Cloudngfw/globalRulestacks/{globalRulestackName}/revert: post: tags: - GlobalRulestack operationId: microsoftAzureGlobalrulestackRevert description: Revert rulestack configuration parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/GlobalRulestackResource.globalRulestackName' 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: GlobalRulestack_revert_MaximumSet_Gen: $ref: ./examples/GlobalRulestack_revert_MaximumSet_Gen.json GlobalRulestack_revert_MinimumSet_Gen: $ref: ./examples/GlobalRulestack_revert_MinimumSet_Gen.json summary: Microsoft Azure Post Providers Paloaltonetworks Cloudngfw Globalrulestacks Globalrulestackname Revert definitions: GlobalRulestackResource: type: object properties: properties: $ref: '#/definitions/RulestackProperties' 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 location: type: string description: Global Location identity: $ref: '#/definitions/Azure.ResourceManager.ManagedIdentityProperties' description: The managed service identities assigned to this resource. description: PaloAltoNetworks GlobalRulestack required: - properties - location allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource NameDescriptionObject: type: object properties: name: type: string description: name value description: type: string description: description value description: object type info required: - name 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. ScopeType: type: string description: Rulestack Type enum: - LOCAL - GLOBAL x-ms-enum: name: ScopeType modelAsString: true Country: type: object properties: code: type: string description: country code description: type: string description: code description description: Country Description required: - code GlobalRulestackResourceUpdate: type: object properties: location: type: string description: Global Location identity: $ref: '#/definitions/Azure.ResourceManager.ManagedIdentityProperties' description: The managed service identities assigned to this resource. properties: $ref: '#/definitions/GlobalRulestackResourceUpdateProperties' description: The type used for update operations of the GlobalRulestackResource. advSecurityObjectModel: type: object properties: type: type: string description: type of object entry: type: array items: $ref: '#/definitions/NameDescriptionObject' x-ms-identifiers: [] x-cadl-name: NameDescriptionObject[] description: URL entry description: List of custom and predefined url category required: - entry securityServicesTypeList: type: object properties: type: type: string description: security services type entry: type: array items: $ref: '#/definitions/NameDescriptionObject' x-ms-identifiers: [] x-cadl-name: NameDescriptionObject[] description: list description: Security services type list required: - entry GlobalRulestackResourceUpdateProperties: type: object properties: panEtag: type: string description: PanEtag info panLocation: type: string description: Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks scope: $ref: '#/definitions/ScopeType' description: Rulestack Type associatedSubscriptions: type: array items: type: string x-cadl-name: string[] description: subscription scope of global rulestack description: type: string description: rulestack description defaultMode: $ref: '#/definitions/DefaultMode' description: Mode for default rules creation minAppIdVersion: type: string description: minimum version securityServices: $ref: '#/definitions/securityServices' description: Security Profile description: The updatable properties of the GlobalRulestackResource. PredefinedUrlCategory: type: object properties: action: type: string name: type: string description: Predefined URL category object required: - action - name ListFirewallsResponse: type: object properties: value: type: array items: type: string x-cadl-name: string[] description: firewalls list nextLink: type: string description: next link description: List firewalls response required: - value DefaultMode: type: string description: Type for Default Mode for rules creation enum: - IPS - FIREWALL - NONE x-ms-enum: name: DefaultMode modelAsString: true ListAppIdResponse: type: object properties: value: type: array items: type: string x-cadl-name: string[] description: List of AppIds nextLink: type: string description: next Link required: - value RulestackProperties: type: object properties: panEtag: type: string description: PanEtag info panLocation: type: string description: Rulestack Location, Required for GlobalRulestacks, Not for LocalRulestacks scope: $ref: '#/definitions/ScopeType' description: Rulestack Type associatedSubscriptions: type: array items: type: string x-cadl-name: string[] description: subscription scope of global rulestack description: type: string description: rulestack description defaultMode: $ref: '#/definitions/DefaultMode' description: Mode for default rules creation minAppIdVersion: type: string description: minimum version provisioningState: $ref: '#/definitions/ProvisioningState' description: Provisioning state of the resource. readOnly: true securityServices: $ref: '#/definitions/securityServices' description: Security Profile description: PAN Rulestack Describe Object PredefinedUrlCategoriesResponse: type: object properties: value: type: array items: $ref: '#/definitions/PredefinedUrlCategory' x-ms-identifiers: [] x-cadl-name: PredefinedUrlCategory[] description: predefined url categories nextLink: type: string description: next link description: predefined url categories response required: - value securityServicesResponse: type: object properties: value: $ref: '#/definitions/securityServicesTypeList' description: response value nextLink: type: string description: next link description: Security services list response required: - value securityServices: type: object properties: vulnerabilityProfile: type: string description: IPs Vulnerability Profile Data antiSpywareProfile: type: string description: Anti spyware Profile data antiVirusProfile: type: string description: anti virus profile data urlFilteringProfile: type: string description: URL filtering profile data fileBlockingProfile: type: string description: File blocking profile data dnsSubscription: type: string description: DNS Subscription profile data outboundUnTrustCertificate: type: string description: Untrusted Egress Decryption profile data outboundTrustCertificate: type: string description: Trusted Egress Decryption profile data description: security services advSecurityObjectListResponse: type: object properties: value: $ref: '#/definitions/advSecurityObjectModel' description: response value nextLink: type: string description: next link description: advanced security object required: - value GlobalRulestackResourceListResult: type: object properties: value: type: array items: $ref: '#/definitions/GlobalRulestackResource' x-cadl-name: GlobalRulestackResource[] description: The items on this page nextLink: type: string description: The link to the next page of items description: The response of a GlobalRulestackResource list operation. required: - value Azure.ResourceManager.ManagedIdentityProperties: type: object properties: tenantId: type: string description: The Active Directory tenant id of the principal. readOnly: true principalId: type: string description: The active directory identifier of this principal. readOnly: true type: $ref: '#/definitions/Azure.ResourceManager.ManagedIdentityType' description: The type of managed identity assigned to this resource. userAssignedIdentities: type: object additionalProperties: $ref: '#/definitions/Azure.ResourceManager.UserAssignedIdentity' description: The identities assigned to this resource by the user. description: The properties of the managed service identities assigned to this resource. required: - type CountriesResponse: type: object properties: value: type: array items: $ref: '#/definitions/Country' x-ms-identifiers: [] x-cadl-name: Country[] description: List of countries nextLink: type: string description: next link description: Countries Response Object required: - 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 Changelog: type: object properties: changes: type: array items: type: string x-cadl-name: string[] description: list of changes lastCommitted: type: string format: date-time description: lastCommitted timestamp lastModified: type: string format: date-time description: lastModified timestamp description: Changelog list required: - changes 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 parameters: GlobalRulestackResource.globalRulestackName: name: globalRulestackName in: path required: true description: GlobalRulestack resource name type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'