azure.keyvault

Key Vault Resource

example:

This policy will find all KeyVaults with 10 or less API Hits over the last 72 hours

policies:
  - name: inactive-keyvaults
    resource: azure.keyvault
    filters:
      - type: metric
        metric: ServiceApiHit
        op: ge
        aggregation: total
        threshold: 10
        timeframe: 72
example:

This policy will find all KeyVaults where Service Principals that have access permissions that exceed read-only.

policies:
    - name: policy
      description:
        Ensure only authorized people have an access
      resource: azure.keyvault
      filters:
        - not:
          - type: whitelist
            key: principalName
            users:
              - account1@sample.com
              - account2@sample.com
            permissions:
              keys:
                - get
              secrets:
                - get
              certificates:
                - get
example:

This policy will find all KeyVaults and add get and list permissions for keys.

policies:
    - name: policy
      description:
        Add get and list permissions to keys access policy
      resource: azure.keyvault
      actions:
        - type: update-access-policy
          operation: add
          access-policies:
            - tenant-id: 00000000-0000-0000-0000-000000000000
              object-id: 11111111-1111-1111-1111-111111111111
              permissions:
                keys:
                  - get
                  - list

Filters

advisor-recommendation

Filter resources by Azure Advisor Recommendations

Select all categories with ‘all’

example:

policies:
  - name: disks-with-cost-recommendations
    resource: azure.disk
    filters:
      - type: advisor-recommendation
        category: Cost
        key: '[].properties.recommendationTypeId'
        op: contains
        value: '48eda464-1485-4dcf-a674-d0905df5054a'
properties:
  category:
    type: string
  default:
    type: object
  key:
    type: string
  op:
    enum:
    - eq
    - equal
    - ne
    - not-equal
    - gt
    - greater-than
    - ge
    - gte
    - le
    - lte
    - lt
    - less-than
    - glob
    - regex
    - regex-case
    - in
    - ni
    - not-in
    - contains
    - difference
    - intersect
    - mod
  tag_key_transforms:
    items:
      type: string
    type: array
  type:
    enum:
    - advisor-recommendation
  value:
    oneOf:
    - type: array
    - type: string
    - type: boolean
    - type: number
    - type: 'null'
  value_from:
    additionalProperties: 'False'
    properties:
      expr:
        oneOf:
        - type: integer
        - type: string
      format:
        enum:
        - csv
        - json
        - txt
        - csv2dict
      headers:
        patternProperties:
          ? ''
          : type: string
        type: object
      query:
        type: string
      url:
        type: string
    required:
    - url
    type: object
  value_path:
    type: string
  value_regex:
    type: string
  value_type:
    enum:
    - age
    - integer
    - expiration
    - normalize
    - size
    - cidr
    - cidr_size
    - swap
    - resource_count
    - expr
    - unique_size
    - date
    - version
    - float
    - duration
required:
- category
- type

firewall-bypass

Filters resources by the firewall bypass rules.

example:

This policy will find all KeyVaults with enabled Azure Services bypass rules

policies:
  - name: keyvault-bypass
    resource: azure.keyvault
    filters:
      - type: firewall-bypass
        mode: equal
        list:
            - AzureServices
properties:
  list:
    items:
      enum:
      - AzureServices
    type: array
  mode:
    enum:
    - include
    - equal
    - any
    - only
  type:
    enum:
    - firewall-bypass
required:
- mode
- list
- type

whitelist

Parent base class for filters and actions.

properties:
  key:
    type: string
  permissions:
    certificates:
      type: array
    keys:
      type: array
    secrets:
      type: array
  type:
    enum:
    - whitelist
  users:
    type: array
required:
- key
- type

Actions

update

Update a keyvault

Only the configured properties are sent, as a PATCH; the vault’s other settings are left unchanged.

To keep the tenant id the same, set it to “keep” To keep the sku settings the same, set it to {“current”: True}

Access policies are not supported here, because the PATCH replaces the vault’s existing access policy entries. Use the update-access-policy action instead, which supports both add and replace operations.

For more information on Vault patch properties:

https://learn.microsoft.com/en-us/python/api/azure-mgmt-keyvault/azure.mgmt.keyvault.models.vaultpatchproperties?view=azure-python

example:

policies:
    - name: keyvault-vault-disable-public-access
      resource: azure.keyvault
      filters:
        - name: test
      actions:
        - type: update
          configuration:
            public_network_access: Disabled
properties:
  configuration:
    additionalProperties: false
    properties:
      create_mode:
        anyOf:
        - type: string
        - enum:
          - recover
          - default
          type: string
      enable_purge_protection:
        type: boolean
      enable_rbac_authorization:
        type: boolean
      enable_soft_delete:
        type: boolean
      enabled_for_deployment:
        type: boolean
      enabled_for_disk_encryption:
        type: boolean
      enabled_for_template_deployment:
        type: boolean
      network_acls:
        additionalProperties: false
        properties:
          bypass:
            anyOf:
            - type: string
            - enum:
              - AzureServices
              - None
              type: string
          default_action:
            anyOf:
            - type: string
            - enum:
              - Allow
              - Deny
              type: string
          ip_rules:
            items:
              additionalProperties: false
              properties:
                value:
                  type: string
              required:
              - value
              type: object
            type: array
          virtual_network_rules:
            items:
              additionalProperties: false
              properties:
                id:
                  type: string
                ignore_missing_vnet_service_endpoint:
                  type: boolean
              required:
              - id
              type: object
            type: array
        required:
        - bypass
        - default_action
        type: object
      public_network_access:
        type: string
      sku:
        anyOf:
        - additionalProperties: false
          properties:
            family:
              anyOf:
              - type: string
              - enum:
                - A
                type: string
            name:
              anyOf:
              - type: string
              - enum:
                - standard
                - premium
                type: string
          required:
          - name
          type: object
        - additionalProperties: false
          properties:
            current:
              enum:
              - true
          required:
          - current
          type: object
      soft_delete_retention_in_days:
        type: integer
      tenant_id:
        type: string
    type: object
  type:
    enum:
    - update
required:
- configuration
- type

update-access-policy

Adds Get and List key access policy to all keyvaults

policies:
  - name: azure-keyvault-update-access-policies
    resource: azure.keyvault
    description: |
      Add key get and list to all keyvault access policies
    actions:
     - type: update-access-policy
       operation: add
       access-policies:
        - tenant-id: 00000000-0000-0000-0000-000000000000
          object-id: 11111111-1111-1111-1111-111111111111
          permissions:
            keys:
              - Get
              - List
properties:
  access-policies:
    items:
      object-id:
        type: string
      permissions:
        certificates:
          items:
            type: string
          type: array
        keys:
          items:
            type: string
          type: array
        secrets:
          items:
            type: string
          type: array
        type: object
      tenant-id:
        type: string
      type: object
    type: array
  operation:
    enum:
    - add
    - replace
    type: string
  type:
    enum:
    - update-access-policy
required:
- operation
- access-policies
- type