support_plan_types

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

Overview

Name	support_plan_types
Type	Resource
Id	azure_extras.addons.support_plan_types

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}".
name	string	The name of the Canonical support plan, i.e. "essential", "standard" or "advanced".
properties	object	Describes Canonical support plan type and status.
type	string	Microsoft.Addons/supportProvider

list_info

Name	Datatype	Description
enabled	boolean	Flag to indicate if this support plan type is currently enabled for the subscription.
oneTimeCharge	string	The one time charge status for the subscription.
supportPlanType	string	Support plan type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, providerName, planTypeName		Returns whether or not the canonical support plan of type {type} is enabled for the subscription.
list_info	select	subscriptionId		Returns the canonical support plan information for all types for the subscription.
create_or_update	insert	subscriptionId, providerName, planTypeName		Creates or updates the Canonical support plan of type {type} for the subscription.
delete	delete	subscriptionId, providerName, planTypeName		Cancels the Canonical support plan of type {type} for the subscription.

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
planTypeName	string	The Canonical support plan type.
providerName	string	The support plan type. For now the only valid type is "canonical".
subscriptionId	string	Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Returns whether or not the canonical support plan of type {type} is enabled for the subscription.

SELECT
id,
name,
properties,
type
FROM azure_extras.addons.support_plan_types
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND providerName = '{{ providerName }}' -- required
AND planTypeName = '{{ planTypeName }}' -- required
;

list_info

Returns the canonical support plan information for all types for the subscription.

SELECT
enabled,
oneTimeCharge,
supportPlanType
FROM azure_extras.addons.support_plan_types
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the Canonical support plan of type {type} for the subscription.

INSERT INTO azure_extras.addons.support_plan_types (
subscriptionId,
providerName,
planTypeName
)
SELECT 
'{{ subscriptionId }}',
'{{ providerName }}',
'{{ planTypeName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: support_plan_types
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the support_plan_types resource.
    - name: providerName
      value: string
      description: Required parameter for the support_plan_types resource.
    - name: planTypeName
      value: string
      description: Required parameter for the support_plan_types resource.

DELETE examples

delete

Cancels the Canonical support plan of type {type} for the subscription.

DELETE FROM azure_extras.addons.support_plan_types
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND providerName = '{{ providerName }}' --required
AND planTypeName = '{{ planTypeName }}' --required
;