Microsoft.Addons (preview:2017-05-15)

2025/09/26 • 5 new, 5 deleted methods

Operations_List (new)
Description :  Lists all of the available Addons RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Addons/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of supported operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Display object with properties of the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: Resource for the operation. ,
Required: False ,
}
string ,
operation:
{
Description: Short description of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
SupportPlanTypes_Get (new)
Description :  Returns whether or not the canonical support plan of type {type} is enabled for the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
planTypeName:
{
Description: The Canonical support plan type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
SupportPlanTypes_CreateOrUpdate (new)
Description :  Creates or updates the Canonical support plan of type {type} for the subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
planTypeName:
{
Description: The Canonical support plan type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
SupportPlanTypes_Delete (new)
Description :  Cancels the Canonical support plan of type {type} for the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
planTypeName:
{
Description: The Canonical support plan type. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
CanonicalSupportPlanTypes_Get (new)
Description :  Returns the Canonical Support Plans as well as whether they are enabled or not for the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
supportPlanType:
{
Description: Support plan type. ,
Enum:
{
essential: No description available. ,
standard: No description available. ,
advanced: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the support plan is enabled for this subscription. ,
Required: False ,
}
boolean ,
willEmitOneTimeChargeWhenEnabled:
{
Description: This indicates that when this support plan is enabled if AddonsRP will emit a one-time charge. ,
Required: False ,
}
boolean ,
willEmitOneTimeChargeIfReEnabled:
{
Description: This indicates that when this support plan is cancelled and then enabled that AddonsRP will emit a one-time charge. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
Operations_List (removed)
Description :  Lists all of the available Addons RP operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Addons/operations
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of supported operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
display:
{
Description: Display object with properties of the operation. ,
Required: False ,
}
{
provider:
{
Description: Resource provider of the operation. ,
Required: False ,
}
string ,
resource:
{
Description: Resource for the operation. ,
Required: False ,
}
string ,
operation:
{
Description: Short description of the operation. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
SupportPlanTypes_Get (removed)
Description :  Returns whether or not the canonical support plan of type {type} is enabled for the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
planTypeName:
{
Description: The Canonical support plan type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
SupportPlanTypes_CreateOrUpdate (removed)
Description :  Creates or updates the Canonical support plan of type {type} for the subscription.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
planTypeName:
{
Description: The Canonical support plan type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
SupportPlanTypes_Delete (removed)
Description :  Cancels the Canonical support plan of type {type} for the subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
planTypeName:
{
Description: The Canonical support plan type. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
id:
{
Description: The id of the ARM resource, e.g. "/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}". ,
Required: False ,
}
string ,
name:
{
Description: The name of the Canonical support plan, i.e. "essential", "standard" or "advanced". ,
Required: False ,
}
string ,
type:
{
Description: Microsoft.Addons/supportProvider ,
Required: False ,
}
string ,
properties:
{
Description: Describes Canonical support plan type and status. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioning state of the resource. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Cancelled: No description available. ,
Purchasing: No description available. ,
Downgrading: No description available. ,
Cancelling: No description available. ,
Upgrading: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}
CanonicalSupportPlanTypes_Get (removed)
Description :  Returns the Canonical Support Plans as well as whether they are enabled or not for the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials that uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
providerName:
{
Description: The support plan type. For now the only valid type is "canonical". ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
supportPlanType:
{
Description: Support plan type. ,
Enum:
{
essential: No description available. ,
standard: No description available. ,
advanced: No description available. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the support plan is enabled for this subscription. ,
Required: False ,
}
boolean ,
willEmitOneTimeChargeWhenEnabled:
{
Description: This indicates that when this support plan is enabled if AddonsRP will emit a one-time charge. ,
Required: False ,
}
boolean ,
willEmitOneTimeChargeIfReEnabled:
{
Description: This indicates that when this support plan is cancelled and then enabled that AddonsRP will emit a one-time charge. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
message:
{
Description: Description of the error. ,
Required: True ,
}
string ,
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: True ,
}
string ,
}