Microsoft Azure Professional Services is a team of experts that helps businesses maximize their investment in Azure cloud services. These professionals offer a range of services including architecture design, implementation, migration, optimization, and ongoing support. They work closely with clients to understand their unique business needs and goals, and develop customized solutions to address them.
swagger: '2.0'
info:
version: 2023-07-01-preview
title: Microsoft Azure ProfessionalService
description: REST APIs for Marketplace Professional Service Offers
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
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:
/subscriptions/{subscriptionId}/providers/Microsoft.ProfessionalService/resources:
get:
tags:
- SubscriptionLevelProfessionalServiceResources
operationId: >-
microsoftAzureProfessionalservicesubscriptionlevelListbyazuresubscription
description: >-
Gets information about all the Subscription Level ProfessionalService in
a certain Azure subscription.
produces:
- application/json
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: >-
Request successful. The request returns the resulting
ProfessionalService resources.
schema:
$ref: '#/definitions/ProfessionalServiceResourceResponseWithContinuation'
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get subscription level ProfessionalService resources in Azure subscription:
$ref: >-
./examples/ProfessionalService/ProfessionalServiceGetAllInAzureSubscription.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Professionalservice Resources
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProfessionalService/resources:
get:
tags:
- SubscriptionLevelProfessionalServiceResources
operationId: microsoftAzureProfessionalservicesubscriptionlevelListbyresourcegroup
description: >-
Gets information about all the Subscription Level ProfessionalService in
a certain resource group.
produces:
- application/json
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: >-
Request successful. The request returns the resulting
ProfessionalService resources.
schema:
$ref: '#/definitions/ProfessionalServiceResourceResponseWithContinuation'
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Get subscription level ProfessionalService resources in resource group:
$ref: >-
./examples/ProfessionalService/ProfessionalServiceGetAllInResourceGroup.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Professionalservice Resources
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProfessionalService/resources/{resourceName}
: get:
tags:
- SubscriptionLevelProfessionalServiceResources
operationId: microsoftAzureProfessionalservicesubscriptionlevelGet
description: >-
Gets information about the specified Subscription Level
ProfessionalService.
produces:
- application/json
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/ResourceNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: >-
Request successful. The request returns the resulting
ProfessionalService resource.
schema:
$ref: '#/definitions/ProfessionalServiceResource'
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-examples:
Get subscription level ProfessionalService resource:
$ref: ./examples/ProfessionalService/ProfessionalServiceGet.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Professionalservice Resources Resourcename
put:
tags:
- SubscriptionLevelProfessionalServiceResources
operationId: microsoftAzureProfessionalservicesubscriptionlevelCreateorupdate
description: Creates or updates a ProfessionalService resource.
produces:
- application/json
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/ResourceNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/ProfessionalServiceResourceCreation'
description: >-
Parameters supplied to the create or update subscription level
ProfessionalService operation.
responses:
'200':
description: Resource creation has completed.
schema:
$ref: '#/definitions/ProfessionalServiceResource'
'202':
description: Accepted and the operation will complete asynchronously.
headers:
Location:
description: The URL to check the status of the asynchronous operation.
type: string
Retry-After:
description: >-
The amount of delay to use while the status of the operation is
checked. The value is expressed in seconds.
format: int32
type: integer
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-examples:
Create subscription level ProfessionalService resource (indefinite term):
$ref: >-
./examples/ProfessionalService/ProfessionalServicePutIndefiniteTerm.json
Create subscription level ProfessionalService resource (with term):
$ref: ./examples/ProfessionalService/ProfessionalServicePutWithTerm.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Professionalservice Resources Resourcename
delete:
tags:
- SubscriptionLevelProfessionalServiceResources
operationId: microsoftAzureProfessionalservicesubscriptionlevelDelete
description: Deletes the specified ProfessionalService.
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/ResourceNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: Delete Operation completed successfully.
'202':
description: Accepted and the operation will complete asynchronously.
headers:
Location:
description: The URL to check the status of the asynchronous operation.
type: string
Retry-After:
description: >-
The amount of delay to use while the status of the operation is
checked. The value is expressed in seconds.
format: int32
type: integer
'204':
description: Delete operation completed successfully.
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete Subscription Level ProfessionalService resource:
$ref: ./examples/ProfessionalService/ProfessionalServiceDelete.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Professionalservice Resources Resourcename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProfessionalService/resources/{resourceName}/unsubscribe
: post:
tags:
- SubscriptionLevelProfessionalServiceResources
operationId: microsoftAzureProfessionalservicesubscriptionlevelUpdatetounsubscribed
description: Unsubscribe from a specified Subscription Level ProfessionalService.
produces:
- application/json
parameters:
- $ref: '#/parameters/SubscriptionIdParameter'
- $ref: '#/parameters/ResourceGroupNameParameter'
- $ref: '#/parameters/ResourceNameParameter'
- $ref: '#/parameters/ApiVersionParameter'
- name: parameters
in: body
required: true
schema:
$ref: '#/definitions/deleteOptions'
description: Parameters supplied to unsubscribe ProfessionalService operation.
responses:
'200':
description: Unsubscribe operation completed successfully.
'202':
description: Accepted and the operation will complete asynchronously.
headers:
Location:
description: The URL to check the status of the asynchronous operation.
type: string
Retry-After:
description: >-
The amount of delay to use while the status of the operation is
checked. The value is expressed in seconds.
format: int32
type: integer
'204':
description: Unsubscribe operation completed successfully.
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-examples:
Unsubscribe Subscription Level ProfessionalService resource:
$ref: ./examples/ProfessionalService/ProfessionalServiceUnsubscribe.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Professionalservice Resources Resourcename Unsubscribe
/providers/Microsoft.ProfessionalService/operationResults/{operationId}:
get:
tags:
- ProfessionalServiceOperations
operationId: microsoftAzureProfessionalserviceoperationGet
description: Gets information about the specified operation progress.
produces:
- application/json
parameters:
- $ref: '#/parameters/OperationIdParameter'
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: >-
Operation ended successfully. The request returns the updated
ProfessionalService resource.
schema:
$ref: '#/definitions/ProfessionalServiceResource'
'202':
description: Accepted and the operation will complete asynchronously.
headers:
Location:
description: The URL to check the status of the asynchronous operation.
type: string
Retry-After:
description: >-
The amount of delay to use while the status of the operation is
checked. The value is expressed in seconds.
format: int32
type: integer
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-examples:
Get operation status:
$ref: ./examples/Operation/GetOperation.json
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: Microsoft Azure Get Providers Microsoft Professionalservice Operationresults Operationid
/providers/Microsoft.ProfessionalService/operations:
get:
tags:
- ProfessionalServiceResources
operationId: microsoftAzureOperationsList
description: Gets all ProfessionalService app operations.
produces:
- application/json
parameters:
- $ref: '#/parameters/ApiVersionParameter'
responses:
'200':
description: OK
schema:
$ref: >-
#/definitions/ProfessionalServiceAppOperationsResponseWithContinuation
default:
description: A response indicating an error.
schema:
$ref: >-
../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
x-ms-examples:
Get ProfessionalService operations:
$ref: ./examples/Operation/GetRpOperations.json
x-ms-pageable:
nextLinkName: nextLink
summary: Microsoft Azure Get Providers Microsoft Professionalservice Operations
definitions:
ProfessionalServiceAppOperationsResponseWithContinuation:
description: professionalService app operation response with continuation.
type: object
properties:
nextLink:
description: the next link to query to get the remaining results.
type: string
value:
description: the value of response.
type: array
x-ms-identifiers: []
items:
$ref: '#/definitions/ProfessionalServiceAppOperation'
ProfessionalServiceAppOperation:
description: professionalService app operations
type: object
properties:
name:
description: the operation name
type: string
display:
description: the operation display
$ref: '#/definitions/ProfessionalServiceAppOperationDisplay'
origin:
description: the operation origin
type: string
isDataAction:
description: whether the operation is a data action or not.
type: boolean
ProfessionalServiceAppOperationDisplay:
description: ProfessionalService app operation display
type: object
properties:
provider:
description: Name of the provider for display purposes
type: string
resource:
description: Name of the resource type for display purposes
type: string
operation:
description: Name of the operation for display purposes
type: string
description:
description: Description of the operation for display purposes
type: string
ProfessionalServiceResource:
description: ProfessionalService REST API resource definition.
type: object
x-ms-azure-resource: true
properties:
properties:
description: professionalService properties
type: object
allOf:
- $ref: '#/definitions/ProfessionalServiceProperties'
- $ref: '#/definitions/ProfessionalServiceCreationProperties'
name:
type: string
description: The name of the resource
readOnly: true
id:
description: The resource uri
type: string
readOnly: true
type:
readOnly: true
type: string
description: Resource type.
tags:
description: the resource tags.
$ref: '#/definitions/Tags'
ProfessionalServiceResourceCreation:
description: ProfessionalService REST API resource definition for creation.
type: object
properties:
id:
description: The resource uri
type: string
readOnly: true
name:
description: The resource name
type: string
type:
readOnly: true
type: string
description: Resource type.
tags:
description: the resource tags.
$ref: '#/definitions/Tags'
location:
type: string
description: >-
Resource location. Only value allowed for ProfessionalService is
'global'
properties:
$ref: '#/definitions/ProfessionalServiceCreationProperties'
description: >-
Properties of the ProfessionalService resource that are relevant for
creation.
ProfessionalServiceProperties:
type: object
description: professionalService resource properties
properties:
status:
type: string
description: The ProfessionalService Subscription Status.
enum:
- NotStarted
- PendingFulfillmentStart
- Subscribed
- Unsubscribed
- Suspended
x-ms-enum:
name: ProfessionalServiceResourceStatus
modelAsString: true
term:
type: object
description: The current Term object.
properties:
termUnit:
type: string
description: >-
The unit term eg P1M,P1Y,P2Y,P3Y meaning month,1year,2year,3year
respectively
startDate:
type: string
description: The start date of the current term
endDate:
type: string
description: The end date of the current term
billingPeriod:
type: string
description: The billing period eg P1M,P1Y for monthly,yearly respectively
isFreeTrial:
type: boolean
description: Whether the current term is a Free Trial term
paymentChannelType:
type: string
description: The Payment channel for the ProfessionalServiceSubscription.
enum:
- SubscriptionDelegated
- CustomerDelegated
x-ms-enum:
name: paymentChannelType
modelAsString: true
paymentChannelMetadata:
type: object
description: >-
The metadata about the ProfessionalService subscription such as the
AzureSubscriptionId and ResourceUri.
additionalProperties:
type: string
created:
type: string
description: The created date of this resource.
readOnly: true
lastModified:
type: string
description: The last modifier date if this resource.
ProfessionalServiceCreationProperties:
type: object
description: properties for creation professionalService
properties:
offerId:
type: string
description: The offer id.
publisherId:
type: string
description: The publisher id.
skuId:
type: string
description: The plan id.
autoRenew:
type: boolean
description: >-
Whether the ProfessionalService subscription will auto renew upon term
end.
quoteId:
type: string
description: The quote id which the ProfessionalService will be purchase with.
storeFront:
type: string
description: The store front which initiates the purchase.
termUnit:
type: string
description: >-
The unit term eg P1M,P1Y,P2Y,P3Y meaning month,1year,2year,3year
respectively
billingPeriod:
type: string
description: The billing period eg P1M,P1Y for monthly,yearly respectively
AccessTokenResult:
description: the ISV access token result response.
type: object
properties:
publisherOfferBaseUri:
description: The Publisher Offer Base Uri
type: string
token:
description: The generated token
type: string
ProfessionalServiceAppResponseWithContinuation:
description: professionalService app response with continuation.
type: object
properties:
nextLink:
description: the next link to query to get the remaining results.
type: string
value:
description: the value of response.
type: array
items:
$ref: '#/definitions/ProfessionalServiceApp'
ProfessionalServiceResourceResponseWithContinuation:
description: professionalService resources response with continuation.
type: object
properties:
nextLink:
description: the next link to query to get the remaining results.
type: string
value:
description: the value of response.
type: array
items:
$ref: '#/definitions/ProfessionalServiceResource'
ProfessionalServiceApp:
description: the professionalServiceApp resource.
type: object
properties:
id:
description: the resource Id.
type: string
readOnly: true
location:
description: the resource location.
type: string
name:
description: the resource name.
type: string
type:
description: the resource type.
type: string
properties:
description: the resource properties.
$ref: '#/definitions/ProfessionalServiceAppProperties'
tags:
description: the resource tags.
$ref: '#/definitions/Tags'
ProfessionalServiceAppProperties:
description: ProfessionalService resource properties.
type: object
properties:
status:
type: string
description: the ProfessionalService resource status.
enum:
- Pending
- Subscribed
- Unsubscribed
- Suspended
- Deactivated
x-ms-enum:
name: ProfessionalServiceAppStatus
modelAsString: true
professionalServiceAppPlan:
description: the resource plan details.
$ref: '#/definitions/ProfessionalServiceAppPlan'
ProfessionalServiceAppPlan:
description: ProfessionalService resource plan.
type: object
properties:
publisher:
description: the publisher id.
type: string
product:
description: the offer id.
type: string
name:
description: the plan id.
type: string
Tags:
type: object
description: the resource tags.
additionalProperties:
type: string
deleteOptions:
description: delete Options
type: object
properties:
unsubscribeOnly:
type: boolean
description: whether it is unsubscribeOnly
reasonCode:
type: number
description: The reasonCode
feedback:
type: string
description: the feedback
parameters:
SubscriptionIdParameter:
name: subscriptionId
in: path
required: true
type: string
description: >-
The Azure subscription ID. This is a GUID-formatted string (e.g.
00000000-0000-0000-0000-000000000000)
x-ms-parameter-location: method
ResourceGroupNameParameter:
name: resourceGroupName
in: path
required: true
type: string
description: The name of the resource group.
x-ms-parameter-location: method
ApiVersionParameter:
name: api-version
in: query
required: true
type: string
x-ms-parameter-location: client
description: The API version to be used with the HTTP request.
OperationIdParameter:
name: operationId
in: path
required: true
type: string
description: the operation Id parameter.
x-ms-parameter-location: method
ResourceNameParameter:
name: resourceName
in: path
required: true
type: string
pattern: ^[a-zA-Z0-9-_.()]{0,63}[a-zA-Z0-9-_()]$
description: The name of the resource.
x-ms-parameter-location: method
tags:
- name: ProfessionalServiceOperations
- name: ProfessionalServiceResources
- name: SubscriptionLevelProfessionalServiceResources