Microsoft Azure Addons Resource Provider is a service that allows users to easily integrate additional features and services into their Azure environments. These add-ons provide users with a wide range of functionalities, such as security and compliance solutions, monitoring and analytics tools, and backup and recovery services.
swagger: '2.0'
info:
title: Microsoft Azure Azure Addons Resource Provider
description: The service for managing third party addons.
version: '2018-03-01'
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: impersonate your user account
paths:
/providers/Microsoft.Addons/operations:
get:
tags:
- Operations
operationId: microsoftAzureOperationsList
description: Lists all of the available Addons RP operations.
x-ms-examples:
Operations_List:
$ref: ./examples/Operations_List.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: List all the operations.
schema:
$ref: '#/definitions/OperationListValue'
default:
description: Unexpected error
schema:
$ref: '#/definitions/ErrorDefinition'
summary: Microsoft Azure Get Providers Microsoft Addons Operations
/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/{providerName}/supportPlanTypes/{planTypeName}:
get:
tags:
- AddonDetails
operationId: microsoftAzureSupportplantypesGet
description: >-
Returns whether or not the canonical support plan of type {type} is
enabled for the subscription.
x-ms-examples:
SupportPlanTypes_Get:
$ref: ./examples/SupportPlanTypes_Get.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/SupportProviderName'
- $ref: '#/parameters/CanonicalSupportPlanType'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CanonicalSupportPlanResponseEnvelope'
'404':
description: Not Found
default:
description: |-
'404' - 'Not Found'.
'400' - 'Bad Request'
schema:
$ref: '#/definitions/ErrorDefinition'
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Addons Supportproviders Providername Supportplantypes Plantypename
put:
tags:
- AddonDetails
operationId: microsoftAzureSupportplantypesCreateorupdate
description: >-
Creates or updates the Canonical support plan of type {type} for the
subscription.
x-ms-long-running-operation: true
x-ms-examples:
SupportPlanTypes_CreateOrUpdate:
$ref: ./examples/SupportPlanTypes_CreateOrUpdate.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/SupportProviderName'
- $ref: '#/parameters/CanonicalSupportPlanType'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CanonicalSupportPlanResponseEnvelope'
'201':
description: Created
schema:
$ref: '#/definitions/CanonicalSupportPlanResponseEnvelope'
'404':
description: Not Found
default:
description: |-
'404' - 'Not Found'.
'400' - 'Bad Request'
schema:
$ref: '#/definitions/ErrorDefinition'
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Addons Supportproviders Providername Supportplantypes Plantypename
delete:
operationId: microsoftAzureSupportplantypesDelete
description: Cancels the Canonical support plan of type {type} for the subscription.
x-ms-long-running-operation: true
x-ms-examples:
SupportPlanTypes_Delete:
$ref: ./examples/SupportPlanTypes_Delete.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/SupportProviderName'
- $ref: '#/parameters/CanonicalSupportPlanType'
responses:
'202':
description: Accepted
headers: {}
schema:
$ref: '#/definitions/CanonicalSupportPlanResponseEnvelope'
'204':
description: No Content
default:
description: BadRequest
schema:
$ref: '#/definitions/ErrorDefinition'
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Providers Microsoft Addons Supportproviders Providername Supportplantypes Plantypename
tags:
- Subscriptions
/subscriptions/{subscriptionId}/providers/Microsoft.Addons/supportProviders/canonical/listSupportPlanInfo:
post:
tags:
- AddonStatus
operationId: microsoftAzureSupportplantypesListinfo
description: >-
Returns the canonical support plan information for all types for the
subscription.
x-ms-examples:
CanonicalListSupportPlanInfo_Post:
$ref: ./examples/CanonicalListSupportPlanInfo_Post.json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
- $ref: '#/parameters/SubscriptionIdParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CanonicalSupportPlanInfo'
'404':
description: Not Found
default:
description: BadRequest
schema:
$ref: '#/definitions/ErrorDefinition'
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Addons Supportproviders Canonical Listsupportplaninfo
definitions:
CanonicalSupportPlanProperties:
type: object
description: The properties of the Canonical support plan.
properties:
provisioningState:
type: string
description: The provisioning state of the resource.
enum:
- Succeeded
- Failed
- Cancelled
- Purchasing
- Downgrading
- Cancelling
- Upgrading
x-ms-enum:
name: ProvisioningState
modelAsString: true
CanonicalSupportPlanResponseEnvelope:
type: object
description: The status of the Canonical support plan.
required:
- properties
properties:
id:
readOnly: true
type: string
description: >-
The id of the ARM resource, e.g.
"/subscriptions/{id}/providers/Microsoft.Addons/supportProvider/{supportProviderName}/supportPlanTypes/{planTypeName}".
name:
readOnly: true
type: string
description: >-
The name of the Canonical support plan, i.e. "essential", "standard"
or "advanced".
type:
readOnly: true
type: string
description: Microsoft.Addons/supportProvider
properties:
type: object
$ref: '#/definitions/CanonicalSupportPlanProperties'
description: Describes Canonical support plan type and status.
x-ms-client-flatten: true
x-ms-azure-resource: true
CanonicalSupportPlanInfo:
type: array
title: Canonical Support Plan Info
description: The status of all Canonical support plans for a subscription.
items:
$ref: '#/definitions/CanonicalSupportPlanInfoDefinition'
x-ms-identifiers: []
CanonicalSupportPlanInfoDefinition:
type: object
description: Definition object with the properties of a canonical plan
properties:
supportPlanType:
type: string
description: Support plan type.
enum:
- essential
- standard
- advanced
x-ms-enum:
name: SupportPlanType
modelAsString: true
enabled:
type: boolean
description: >-
Flag to indicate if this support plan type is currently enabled for
the subscription.
oneTimeCharge:
type: string
description: The one time charge status for the subscription.
enum:
- 'no'
- onEnabled
- onReenabled
x-ms-enum:
name: OneTimeCharge
modelAsString: true
OperationListValue:
type: object
description: List of supported operations.
properties:
value:
$ref: '#/definitions/OperationList'
OperationList:
type: array
description: List of supported operations.
items:
$ref: '#/definitions/OperationsDefinition'
x-ms-identifiers:
- name
OperationsDefinition:
type: object
description: Definition object with the name and properties of an operation.
properties:
name:
type: string
description: Name of the operation.
display:
$ref: '#/definitions/OperationsDisplayDefinition'
description: Display object with properties of the operation.
OperationsDisplayDefinition:
type: object
description: Display object with properties of the operation.
properties:
provider:
type: string
description: Resource provider of the operation.
resource:
type: string
description: Resource for the operation.
operation:
type: string
description: Short description of the operation.
description:
type: string
description: Description of the operation.
ErrorDefinition:
type: object
title: Error
description: Error description and code explaining why an operation failed.
required:
- message
- code
properties:
message:
type: string
description: Description of the error.
code:
type: string
description: >-
Service specific error code which serves as the substatus for the HTTP
error code.
parameters:
SubscriptionIdParameter:
name: subscriptionId
in: path
required: true
type: string
description: >-
Subscription credentials that uniquely identify the Microsoft Azure
subscription. The subscription ID forms part of the URI for every service
call.
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
description: Client API version.
SupportProviderName:
name: providerName
in: path
required: true
type: string
description: The support plan type. For now the only valid type is "canonical".
x-ms-parameter-location: method
CanonicalSupportPlanType:
name: planTypeName
in: path
required: true
type: string
description: The Canonical support plan type.
enum:
- Essential
- Standard
- Advanced
x-ms-enum:
name: PlanTypeName
modelAsString: true
x-ms-parameter-location: method
OperationResultsIdParameter:
name: operationResultsId
in: path
required: true
type: string
description: The id representing an async operation.
x-ms-parameter-location: method
tags:
- name: AddonDetails
- name: AddonStatus
- name: Operations
- name: Subscriptions