Microsoft.SaaS (preview:2018-03-01-beta)

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

operations_List (new)
Description :  Gets all SaaS app operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
name:
{
Description: the operation name ,
Required: False ,
}
string ,
display:
{
Description: the operation display ,
Required: False ,
}
{
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
}
,
origin:
{
Description: the operation origin ,
Required: False ,
}
string ,
isDataAction:
{
Description: whether the operation is a data action or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_List (new)
Description :  Gets all SaaS resources by subscription id and resource group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/applications
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
id:
{
Description: the resource Id. ,
Required: False ,
}
string ,
location:
{
Description: the resource location. ,
Required: False ,
}
string ,
name:
{
Description: the resource name. ,
Required: False ,
}
string ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
properties:
{
Description: the resource properties. ,
Required: False ,
}
{
status:
{
Description: the Saas resource status. ,
Enum:
{
Pending: No description available. ,
Subscribed: No description available. ,
Unsubscribed: No description available. ,
Suspended: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
saasAppPlan:
{
Description: the resource plan details. ,
Required: False ,
}
{
publisher:
{
Description: the publisher id. ,
Required: False ,
}
string ,
product:
{
Description: the offer id. ,
Required: False ,
}
string ,
name:
{
Description: the plan id. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_Delete (new)
Description :  Deletes the specified SaaS.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.SaaS/saasresources/{resourceId}
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to delete saas operation. ,
Required: True ,
}
{
unsubscribeOnly:
{
Description: whether it is unsubscribeOnly ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: The reasonCode ,
Required: False ,
}
number ,
feedback:
{
Description: the feedback ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_GetResource (new)
Description :  Gets information about the specified SaaS.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/saasresources/{resourceId}
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_UpdateResource (new)
Description :  Updates a SaaS resource.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.SaaS/saasresources/{resourceId}
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_CreateResource (new)
Description :  Creates a SaaS resource.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.SaaS/saasresources
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasResources_List (new)
Description :  Get All Resources
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/saasresources
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasResource-listAccessToken (new)
Description :  Gets the ISV access token for a SaaS resource.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.SaaS/saasresources/{resourceId}/listAccessToken
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
publisherOfferBaseUri:
{
Description: The Publisher Offer Base Uri ,
Required: False ,
}
string ,
token:
{
Description: The generated token ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_ListByAzureSubscription (new)
Description :  Gets information about all the Subscription Level SaaS in a certain Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SaaS/resources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_ListByResourceGroup (new)
Description :  Gets information about all the Subscription Level SaaS in a certain resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_Get (new)
Description :  Gets information about the specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_CreateOrUpdate (new)
Description :  Creates or updates a SaaS resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update subscription level saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_Update (new)
Description :  Updates a SaaS Subscription Level resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_Delete (new)
Description :  Deletes the specified SaaS.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_UpdateToUnsubscribed (new)
Description :  Unsubscribe from a specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}/unsubscribe
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to unsubscribe saas operation. ,
Required: True ,
}
{
unsubscribeOnly:
{
Description: whether it is unsubscribeOnly ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: The reasonCode ,
Required: False ,
}
number ,
feedback:
{
Description: the feedback ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_listAccessToken (new)
Description :  Gets the ISV access token for a specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}/listAccessToken
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
publisherOfferBaseUri:
{
Description: The Publisher Offer Base Uri ,
Required: False ,
}
string ,
token:
{
Description: The generated token ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_ValidateMoveResources (new)
Description :  Validate whether a specified Subscription Level SaaS can be moved.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
moveResourceParameter:
{
Description: Object that represents the resources to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Description: The target resource group uri for the move ,
Required: False ,
}
string ,
resources:
{
Description: The resource uris to move ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_MoveResources (new)
Description :  Move a specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
moveResourceParameter:
{
Description: Object that represents the resources to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Description: The target resource group uri for the move ,
Required: False ,
}
string ,
resources:
{
Description: The resource uris to move ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaSOperation_Get (new)
Description :  Gets information about the specified operation progress.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/operationResults/{operationId}
{
operationId:
{
Description: the operation Id parameter. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
operations_List (removed)
Description :  Gets all SaaS app operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
name:
{
Description: the operation name ,
Required: False ,
}
string ,
display:
{
Description: the operation display ,
Required: False ,
}
{
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: Name of the resource type for display purposes ,
Required: False ,
}
string ,
operation:
{
Description: Name of the operation for display purposes ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation for display purposes ,
Required: False ,
}
string ,
}
,
origin:
{
Description: the operation origin ,
Required: False ,
}
string ,
isDataAction:
{
Description: whether the operation is a data action or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Applications_List (removed)
Description :  Gets all SaaS resources by subscription id and resource group name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/applications
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
id:
{
Description: the resource Id. ,
Required: False ,
}
string ,
location:
{
Description: the resource location. ,
Required: False ,
}
string ,
name:
{
Description: the resource name. ,
Required: False ,
}
string ,
type:
{
Description: the resource type. ,
Required: False ,
}
string ,
properties:
{
Description: the resource properties. ,
Required: False ,
}
{
status:
{
Description: the Saas resource status. ,
Enum:
{
Pending: No description available. ,
Subscribed: No description available. ,
Unsubscribed: No description available. ,
Suspended: No description available. ,
Deactivated: No description available. ,
}
,
Required: False ,
}
enum ,
saasAppPlan:
{
Description: the resource plan details. ,
Required: False ,
}
{
publisher:
{
Description: the publisher id. ,
Required: False ,
}
string ,
product:
{
Description: the offer id. ,
Required: False ,
}
string ,
name:
{
Description: the plan id. ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_Delete (removed)
Description :  Deletes the specified SaaS.
Reference :  Link ¶

⚼ Request

DELETE:  /providers/Microsoft.SaaS/saasresources/{resourceId}
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to delete saas operation. ,
Required: True ,
}
{
unsubscribeOnly:
{
Description: whether it is unsubscribeOnly ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: The reasonCode ,
Required: False ,
}
number ,
feedback:
{
Description: the feedback ,
Required: False ,
}
string ,
}
,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_GetResource (removed)
Description :  Gets information about the specified SaaS.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/saasresources/{resourceId}
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_UpdateResource (removed)
Description :  Updates a SaaS resource.
Reference :  Link ¶

⚼ Request

PATCH:  /providers/Microsoft.SaaS/saasresources/{resourceId}
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaS_CreateResource (removed)
Description :  Creates a SaaS resource.
Reference :  Link ¶

⚼ Request

PUT:  /providers/Microsoft.SaaS/saasresources
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasResources_List (removed)
Description :  Get All Resources
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/saasresources
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasResource-listAccessToken (removed)
Description :  Gets the ISV access token for a SaaS resource.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.SaaS/saasresources/{resourceId}/listAccessToken
{
resourceId:
{
Description: The Saas resource ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
publisherOfferBaseUri:
{
Description: The Publisher Offer Base Uri ,
Required: False ,
}
string ,
token:
{
Description: The generated token ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_ListByAzureSubscription (removed)
Description :  Gets information about all the Subscription Level SaaS in a certain Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SaaS/resources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_ListByResourceGroup (removed)
Description :  Gets information about all the Subscription Level SaaS in a certain resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: the next link to query to get the remaining results. ,
Required: False ,
}
string ,
value:
{
Description: the value of response. ,
Required: False ,
}
[
{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_Get (removed)
Description :  Gets information about the specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_CreateOrUpdate (removed)
Description :  Creates or updates a SaaS resource.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the create or update subscription level saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_Update (removed)
Description :  Updates a SaaS Subscription Level resource.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the update saas operation. ,
Required: True ,
}
{
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
name:
{
Description: The resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
location:
{
Description: Resource location. Only value allowed for SaaS is 'global' ,
Required: False ,
}
string ,
properties:
{
Description: Properties of the SaaS resource that are relevant for creation. ,
Required: False ,
}
{
offerId:
{
Description: The offer id. ,
Required: False ,
}
string ,
publisherId:
{
Description: The publisher id. ,
Required: False ,
}
string ,
quantity:
{
Description: The seat count. ,
Required: False ,
}
number ,
skuId:
{
Description: The plan id. ,
Required: False ,
}
string ,
paymentChannelType:
{
Description: The Payment channel for the SaasSubscription. ,
Enum:
{
SubscriptionDelegated: No description available. ,
CustomerDelegated: No description available. ,
}
,
Required: False ,
}
enum ,
paymentChannelMetadata:
{
Description: The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. ,
Required: False ,
}
object ,
saasResourceName:
{
Description: The SaaS resource name. ,
Required: False ,
}
string ,
termId:
{
Description: The current Term id. ,
Required: False ,
}
string ,
autoRenew:
{
Description: Whether the SaaS subscription will auto renew upon term end. ,
Required: False ,
}
boolean ,
publisherTestEnvironment:
{
Description: The environment in the publisher side for this resource. ,
Required: False ,
}
string ,
saasSubscriptionId:
{
Description: The saas subscription id used for tenant to subscription level migration request. ,
Required: False ,
}
string ,
saasSessionId:
{
Description: The saas session id used for dev service migration request. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_Delete (removed)
Description :  Deletes the specified SaaS.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_UpdateToUnsubscribed (removed)
Description :  Unsubscribe from a specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}/unsubscribe
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to unsubscribe saas operation. ,
Required: True ,
}
{
unsubscribeOnly:
{
Description: whether it is unsubscribeOnly ,
Required: False ,
}
boolean ,
reasonCode:
{
Description: The reasonCode ,
Required: False ,
}
number ,
feedback:
{
Description: the feedback ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_listAccessToken (removed)
Description :  Gets the ISV access token for a specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SaaS/resources/{resourceName}/listAccessToken
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceName:
{
Description: The name of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
publisherOfferBaseUri:
{
Description: The Publisher Offer Base Uri ,
Required: False ,
}
string ,
token:
{
Description: The generated token ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_ValidateMoveResources (removed)
Description :  Validate whether a specified Subscription Level SaaS can be moved.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
moveResourceParameter:
{
Description: Object that represents the resources to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Description: The target resource group uri for the move ,
Required: False ,
}
string ,
resources:
{
Description: The resource uris to move ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaasSubscriptionLevel_MoveResources (removed)
Description :  Move a specified Subscription Level SaaS.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
moveResourceParameter:
{
Description: Object that represents the resources to move. ,
Required: True ,
}
{
targetResourceGroup:
{
Description: The target resource group uri for the move ,
Required: False ,
}
string ,
resources:
{
Description: The resource uris to move ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SaaSOperation_Get (removed)
Description :  Gets information about the specified operation progress.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SaaS/operationResults/{operationId}
{
operationId:
{
Description: the operation Id parameter. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: saas properties ,
Required: False ,
}
object ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
id:
{
Description: The resource uri ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
tags:
{
Description: the resource tags. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{
location:
{
Description: The URL to check the status of the asynchronous operation. ,
}
string ,
retry-after:
{
Description: The amount of delay to use while the status of the operation is checked. The value is expressed in seconds. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}