Resource Type: azure_query_key

Defined in:
lib/puppet/type/azure_query_key.rb
Providers:
arm

Overview

Describes an API key for a given Azure Search service that has permissions for query operations only.

Properties

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • key

    The value of the query API key.

Parameters

  • api_version

    The API version to use for each request. The current version is 2015-08-19.

  • name (namevar)

    The name of the query API key; may be empty.

  • provider

    The specific backend to use for this ‘azure_query_key` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • resource_group_name

    The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal.

  • search_service_name

    The name of the Azure Search service associated with the specified resource group.

  • subscription_id

    The unique identifier for a Microsoft Azure subscription. You can obtain this value from the Azure Resource Manager API or the portal.