quota_tiers

Creates, updates, deletes, gets or lists a quota_tiers resource.

Overview

Name	quota_tiers
Type	Resource
Id	azure.cognitive_services.quota_tiers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
assignmentDate	string (date-time)	The date on which the current tier was assigned to the subscription (UTC).
currentTierName	string	Name of the current quota tier for the subscription.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tierUpgradeEligibilityInfo	object	Information about the quota tier upgrade eligibility for the subscription.
tierUpgradePolicy	string	Gets the tier upgrade policy for the subscription. Known values are: "OnceUpgradeIsAvailable" and "NoAutoUpgrade". (OnceUpgradeIsAvailable, NoAutoUpgrade)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
assignmentDate	string (date-time)	The date on which the current tier was assigned to the subscription (UTC).
currentTierName	string	Name of the current quota tier for the subscription.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tierUpgradeEligibilityInfo	object	Information about the quota tier upgrade eligibility for the subscription.
tierUpgradePolicy	string	Gets the tier upgrade policy for the subscription. Known values are: "OnceUpgradeIsAvailable" and "NoAutoUpgrade". (OnceUpgradeIsAvailable, NoAutoUpgrade)
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	default_name, subscription_id		Gets the Quota Tier for a subscription. Gets the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.
list_by_subscription	select	subscription_id		Returns all the resources of a particular type belonging to a subscription.
create_or_update	insert	default_name, subscription_id		Updates the Quota Tier resource for a subscription. Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.
update	update	default_name, subscription_id		Updates the Quota Tier resource for a subscription. The only properties that can be updated are "tierUpgradePolicy". Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.
create_or_update	replace	default_name, subscription_id		Updates the Quota Tier resource for a subscription. Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
default_name	string	Default parameter. Leave the value as default. Required.
subscription_id	string

SELECT examples

get

Gets the Quota Tier for a subscription. Gets the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.

SELECT
id,
name,
assignmentDate,
currentTierName,
systemData,
tierUpgradeEligibilityInfo,
tierUpgradePolicy,
type
FROM azure.cognitive_services.quota_tiers
WHERE default_name = '{{ default_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Returns all the resources of a particular type belonging to a subscription.

SELECT
id,
name,
assignmentDate,
currentTierName,
systemData,
tierUpgradeEligibilityInfo,
tierUpgradePolicy,
type
FROM azure.cognitive_services.quota_tiers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Updates the Quota Tier resource for a subscription. Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.

INSERT INTO azure.cognitive_services.quota_tiers (
properties,
default_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ default_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: quota_tiers
props:
  - name: default_name
    value: "{{ default_name }}"
    description: Required parameter for the quota_tiers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the quota_tiers resource.
  - name: properties
    description: |
      Properties of quota tier resource.
    value:
      currentTierName: "{{ currentTierName }}"
      tierUpgradePolicy: "{{ tierUpgradePolicy }}"
      assignmentDate: "{{ assignmentDate }}"
      tierUpgradeEligibilityInfo:
        nextTierName: "{{ nextTierName }}"
        upgradeAvailabilityStatus: "{{ upgradeAvailabilityStatus }}"
        upgradeApplicableDate: "{{ upgradeApplicableDate }}"
        upgradeUnavailabilityReason: "{{ upgradeUnavailabilityReason }}"

UPDATE examples

update

Updates the Quota Tier resource for a subscription. The only properties that can be updated are "tierUpgradePolicy". Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.

UPDATE azure.cognitive_services.quota_tiers
SET 
properties = '{{ properties }}'
WHERE 
default_name = '{{ default_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Updates the Quota Tier resource for a subscription. Update the Quota Tier information for the given subscription. QuotaTiers is a subscription wide resource type. It holds current tier information.

REPLACE azure.cognitive_services.quota_tiers
SET 
properties = '{{ properties }}'
WHERE 
default_name = '{{ default_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;