Microsoft.AnalysisServices (preview:2017-08-01-beta)

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

Servers_GetDetails (new)
Description :  Gets details about the specified Analysis Services server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Create (new)
Description :  Provisions the specified Analysis Services server based on the configuration specified in the request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
serverParameters:
{
Description: Contains the information used to provision the Analysis Services server. ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Delete (new)
Description :  Deletes the specified Analysis Services server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Update (new)
Description :  Updates the current state of the specified Analysis Services server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
serverUpdateParameters:
{
Description: Request object that contains the updated information for the server. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Key-value pairs of additional provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
asAdministrators:
{
Description: A collection of AS server administrators ,
Required: False ,
}
{
members:
{
Description: An array of administrator user identities. ,
Required: False ,
}
[
string ,
]
,
}
,
backupBlobContainerUri:
{
Description: The SAS container URI to the backup container. ,
Required: False ,
}
string ,
gatewayDetails:
{
Description: The gateway details configured for the AS server. ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Gateway resource to be associated with the server. ,
Required: False ,
}
string ,
gatewayObjectId:
{
Description: Gateway object id from in the DMTS cluster for the gateway resource. ,
Required: False ,
}
string ,
dmtsClusterUri:
{
Description: Uri of the DMTS cluster. ,
Required: False ,
}
string ,
}
,
ipV4FirewallSettings:
{
Description: The firewall settings for the AS server. ,
Required: False ,
}
{
firewallRules:
{
Description: An array of firewall rules. ,
Required: False ,
}
[
{
firewallRuleName:
{
Description: The rule name. ,
Required: False ,
}
string ,
rangeStart:
{
Description: The start range of IPv4. ,
Required: False ,
}
string ,
rangeEnd:
{
Description: The end range of IPv4. ,
Required: False ,
}
string ,
}
,
]
,
enablePowerBIService:
{
Description: The indicator of enabling PBI service. ,
Required: False ,
}
boolean ,
}
,
querypoolConnectionMode:
{
Description: How the read-write server's participation in the query pool is controlled.
It can have the following values:
  • readOnly - indicates that the read-write server is intended not to participate in query operations
  • all - indicates that the read-write server can participate in query operations
Specifying readOnly when capacity is 1 results in error. ,
Enum:
{
All: No description available. ,
ReadOnly: No description available. ,
}
,
Required: False ,
}
enum ,
managedMode:
{
Description: The managed mode of the server (0 = not managed, 1 = managed). ,
Format: int32 ,
Required: False ,
}
integer ,
serverMonitorMode:
{
Description: The server monitor mode for AS server ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Suspend (new)
Description :  Suspends operation of the specified Analysis Services server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Resume (new)
Description :  Resumes operation of the specified Analysis Services server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/resume
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListByResourceGroup (new)
Description :  Gets all the Analysis Services servers for the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Analysis Services resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_List (new)
Description :  Lists all the Analysis Services servers for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/servers
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Analysis Services resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListSkusForNew (new)
Description :  Lists eligible SKUs for Analysis Services resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/skus
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for new resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListSkusForExisting (new)
Description :  Lists eligible SKUs for an Analysis Services resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/skus
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for existing resources. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU in SKU details for existing resources. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListGatewayStatus (new)
Description :  Return the gateway status of the specified Analysis Services server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/listGatewayStatus
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Live message of list gateway. Status: 0 - Live ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Error of the list gateway status. ,
Required: False ,
}
{
code:
{
Description: Error code of list gateway. ,
Required: False ,
}
string ,
message:
{
Description: Error message of list gateway. ,
Required: False ,
}
string ,
}
,
}
Servers_DissociateGateway (new)
Description :  Dissociates a Unified Gateway associated with the server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/dissociateGateway
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_CheckNameAvailability (new)
Description :  Check the name availability in the target location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/checkNameAvailability
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
serverParameters:
{
Description: Contains the information used to provision the Analysis Services server. ,
Required: True ,
}
{
name:
{
Description: Name for checking availability. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of azure analysis services. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicator of available of the server name. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of unavailability. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message of the request unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListOperationResults (new)
Description :  List the result of the specified operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationresults/{operationId}
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListOperationStatuses (new)
Description :  List the status of operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationstatuses/{operationId}
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 (new)
Description :  Lists all of the available consumption REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AnalysisServices/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of analysis services operations supported by the Microsoft.AnalysisServices resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Consumption. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation object. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_GetDetails (removed)
Description :  Gets details about the specified Analysis Services server.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Create (removed)
Description :  Provisions the specified Analysis Services server based on the configuration specified in the request.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63. ,
Required: True ,
}
string ,
serverParameters:
{
Description: Contains the information used to provision the Analysis Services server. ,
Required: True ,
}
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Delete (removed)
Description :  Deletes the specified Analysis Services server.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Update (removed)
Description :  Updates the current state of the specified Analysis Services server.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
serverUpdateParameters:
{
Description: Request object that contains the updated information for the server. ,
Required: True ,
}
{
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
tags:
{
Description: Key-value pairs of additional provisioning properties. ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
asAdministrators:
{
Description: A collection of AS server administrators ,
Required: False ,
}
{
members:
{
Description: An array of administrator user identities. ,
Required: False ,
}
[
string ,
]
,
}
,
backupBlobContainerUri:
{
Description: The SAS container URI to the backup container. ,
Required: False ,
}
string ,
gatewayDetails:
{
Description: The gateway details configured for the AS server. ,
Required: False ,
}
{
gatewayResourceId:
{
Description: Gateway resource to be associated with the server. ,
Required: False ,
}
string ,
gatewayObjectId:
{
Description: Gateway object id from in the DMTS cluster for the gateway resource. ,
Required: False ,
}
string ,
dmtsClusterUri:
{
Description: Uri of the DMTS cluster. ,
Required: False ,
}
string ,
}
,
ipV4FirewallSettings:
{
Description: The firewall settings for the AS server. ,
Required: False ,
}
{
firewallRules:
{
Description: An array of firewall rules. ,
Required: False ,
}
[
{
firewallRuleName:
{
Description: The rule name. ,
Required: False ,
}
string ,
rangeStart:
{
Description: The start range of IPv4. ,
Required: False ,
}
string ,
rangeEnd:
{
Description: The end range of IPv4. ,
Required: False ,
}
string ,
}
,
]
,
enablePowerBIService:
{
Description: The indicator of enabling PBI service. ,
Required: False ,
}
boolean ,
}
,
querypoolConnectionMode:
{
Description: How the read-write server's participation in the query pool is controlled.
It can have the following values:
  • readOnly - indicates that the read-write server is intended not to participate in query operations
  • all - indicates that the read-write server can participate in query operations
Specifying readOnly when capacity is 1 results in error. ,
Enum:
{
All: No description available. ,
ReadOnly: No description available. ,
}
,
Required: False ,
}
enum ,
managedMode:
{
Description: The managed mode of the server (0 = not managed, 1 = managed). ,
Format: int32 ,
Required: False ,
}
integer ,
serverMonitorMode:
{
Description: The server monitor mode for AS server ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (202)

{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Suspend (removed)
Description :  Suspends operation of the specified Analysis Services server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_Resume (removed)
Description :  Resumes operation of the specified Analysis Services server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/resume
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListByResourceGroup (removed)
Description :  Gets all the Analysis Services servers for the given resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Analysis Services resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_List (removed)
Description :  Lists all the Analysis Services servers for the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/servers
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: An array of Analysis Services resources. ,
Required: True ,
}
[
{
properties:
{
Description: Properties of the provision operation request. ,
Required: False ,
}
{
state:
{
Description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. ,
Enum:
{
Deleting: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Paused: No description available. ,
Suspended: No description available. ,
Provisioning: No description available. ,
Updating: No description available. ,
Suspending: No description available. ,
Pausing: No description available. ,
Resuming: No description available. ,
Preparing: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
serverFullName:
{
Description: The full name of the Analysis Services resource. ,
Required: False ,
}
string ,
sku:
{
Description: The SKU of the Analysis Services resource. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListSkusForNew (removed)
Description :  Lists eligible SKUs for Analysis Services resource provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/skus
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for new resources. ,
Required: False ,
}
[
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListSkusForExisting (removed)
Description :  Lists eligible SKUs for an Analysis Services resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/skus
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The collection of available SKUs for existing resources. ,
Required: False ,
}
[
{
sku:
{
Description: The SKU in SKU details for existing resources. ,
Required: False ,
}
{
name:
{
Description: Name of the SKU level. ,
Required: True ,
}
string ,
tier:
{
Description: The name of the Azure pricing tier to which the SKU applies. ,
Enum:
{
Development: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The number of instances in the read only query pool. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListGatewayStatus (removed)
Description :  Return the gateway status of the specified Analysis Services server instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/listGatewayStatus
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Live message of list gateway. Status: 0 - Live ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Error of the list gateway status. ,
Required: False ,
}
{
code:
{
Description: Error code of list gateway. ,
Required: False ,
}
string ,
message:
{
Description: Error message of list gateway. ,
Required: False ,
}
string ,
}
,
}
Servers_DissociateGateway (removed)
Description :  Dissociates a Unified Gateway associated with the server.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/dissociateGateway
{
resourceGroupName:
{
Description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. ,
Required: True ,
}
string ,
serverName:
{
Description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_CheckNameAvailability (removed)
Description :  Check the name availability in the target location.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/checkNameAvailability
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
serverParameters:
{
Description: Contains the information used to provision the Analysis Services server. ,
Required: True ,
}
{
name:
{
Description: Name for checking availability. ,
Required: False ,
}
string ,
type:
{
Description: The resource type of azure analysis services. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicator of available of the server name. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason of unavailability. ,
Required: False ,
}
string ,
message:
{
Description: The detailed message of the request unavailability. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListOperationResults (removed)
Description :  List the result of the specified operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationresults/{operationId}
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
Servers_ListOperationStatuses (removed)
Description :  List the status of operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationstatuses/{operationId}
{
location:
{
Description: The region name which the operation will lookup into. ,
Required: True ,
}
string ,
operationId:
{
Description: The target operation Id. ,
Required: True ,
}
string ,
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (202)

{
id:
{
Description: The operation Id. ,
Required: False ,
}
string ,
name:
{
Description: The operation name. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the operation. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the operation. ,
Required: False ,
}
string ,
status:
{
Description: The status of the operation. ,
Required: False ,
}
string ,
error:
{
Description: The error detail of the operation if any. ,
Required: False ,
}
{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 :  Lists all of the available consumption REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AnalysisServices/operations
{
api-version:
{
Description: The client API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of analysis services operations supported by the Microsoft.AnalysisServices resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation}. ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Consumption. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: UsageDetail, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation object. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The origin ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object ,
Required: False ,
}
{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
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 ,
}
,
]
,
}
,
]
,
}
,
}