@datafire/azure_analysisservices

Client library for AzureAnalysisServices

Installation and Usage

npm install --save @datafire/azure_analysisservices

let azure_analysisservices = require('@datafire/azure_analysisservices').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The Azure Analysis Services Web API provides a RESTful set of web services that enables users to create, retrieve, update, and delete Analysis Services servers

Actions

Operations_List

Lists all of the available consumption REST API operations.

azure_analysisservices.Operations_List({
  "api-version": ""
}, context)

Input

• input object
  • api-version required string: The client API version.

Output

• output OperationListResult

Servers_CheckNameAvailability

Check the name availability in the target location.

azure_analysisservices.Servers_CheckNameAvailability({
  "location": "",
  "serverParameters": {},
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • location required string: The region name which the operation will lookup into.
  • serverParameters required CheckServerNameAvailabilityParameters
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output CheckServerNameAvailabilityResult

Servers_ListOperationResults

List the result of the specified operation.

azure_analysisservices.Servers_ListOperationResults({
  "location": "",
  "operationId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • location required string: The region name which the operation will lookup into.
  • operationId required string: The target operation Id.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Servers_ListOperationStatuses

List the status of operation.

azure_analysisservices.Servers_ListOperationStatuses({
  "location": "",
  "operationId": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • location required string: The region name which the operation will lookup into.
  • operationId required string: The target operation Id.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output OperationStatus

Servers_List

Lists all the Analysis Services servers for the given subscription.

azure_analysisservices.Servers_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AnalysisServicesServers

Servers_ListSkusForNew

Lists eligible SKUs for Analysis Services resource provider.

azure_analysisservices.Servers_ListSkusForNew({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SkuEnumerationForNewResourceResult

Servers_ListByResourceGroup

Gets all the Analysis Services servers for the given resource group.

azure_analysisservices.Servers_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AnalysisServicesServers

Servers_Delete

Deletes the specified Analysis Services server.

azure_analysisservices.Servers_Delete({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Servers_GetDetails

Gets details about the specified Analysis Services server.

azure_analysisservices.Servers_GetDetails({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AnalysisServicesServer

Servers_Update

Updates the current state of the specified Analysis Services server.

azure_analysisservices.Servers_Update({
  "resourceGroupName": "",
  "serverName": "",
  "serverUpdateParameters": {},
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
  • serverUpdateParameters required AnalysisServicesServerUpdateParameters
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AnalysisServicesServer

Servers_Create

Provisions the specified Analysis Services server based on the configuration specified in the request.

azure_analysisservices.Servers_Create({
  "resourceGroupName": "",
  "serverName": "",
  "serverParameters": {
    "location": "",
    "sku": {
      "name": ""
    }
  },
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63.
  • serverParameters required AnalysisServicesServer
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output AnalysisServicesServer

Servers_DissociateGateway

Dissociates a Unified Gateway associated with the server.

azure_analysisservices.Servers_DissociateGateway({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Servers_ListGatewayStatus

Return the gateway status of the specified Analysis Services server instance.

azure_analysisservices.Servers_ListGatewayStatus({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output GatewayListStatusLive

Servers_Resume

Resumes operation of the specified Analysis Services server instance.

azure_analysisservices.Servers_Resume({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Servers_ListSkusForExisting

Lists eligible SKUs for an Analysis Services resource.

azure_analysisservices.Servers_ListSkusForExisting({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

• output SkuEnumerationForExistingResourceResult

Servers_Suspend

Suspends operation of the specified Analysis Services server instance.

azure_analysisservices.Servers_Suspend({
  "resourceGroupName": "",
  "serverName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • resourceGroupName required string: 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.
  • serverName required string: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63.
  • api-version required string: The client API version.
  • subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Definitions

AnalysisServicesServer

• AnalysisServicesServer object: Represents an instance of an Analysis Services resource.
  • properties AnalysisServicesServerProperties
  • id string: An identifier that represents the Analysis Services resource.
  • location required string: Location of the Analysis Services resource.
  • name string: The name of the Analysis Services resource.
  • sku required ResourceSku
  • tags object: Key-value pairs of additional resource provisioning properties.
  • type string: The type of the Analysis Services resource.

AnalysisServicesServerMutableProperties

• AnalysisServicesServerMutableProperties object: An object that represents a set of mutable Analysis Services resource properties.
  • asAdministrators ServerAdministrators
  • backupBlobContainerUri string: The SAS container URI to the backup container.
  • gatewayDetails GatewayDetails
  • ipV4FirewallSettings IPv4FirewallSettings
  • querypoolConnectionMode string (values: All, ReadOnly): 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 operationsall - indicates that the read-write server can participate in query operationsSpecifying readOnly when capacity is 1 results in error.

AnalysisServicesServerProperties

• AnalysisServicesServerProperties object: Properties of Analysis Services resource.
  • provisioningState string (values: Deleting, Succeeded, Failed, Paused, Suspended, Provisioning, Updating, Suspending, Pausing, Resuming, Preparing, Scaling): The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning.
  • serverFullName string: The full name of the Analysis Services resource.
  • state string (values: Deleting, Succeeded, Failed, Paused, Suspended, Provisioning, Updating, Suspending, Pausing, Resuming, Preparing, Scaling): The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning.
  • asAdministrators ServerAdministrators
  • backupBlobContainerUri string: The SAS container URI to the backup container.
  • gatewayDetails GatewayDetails
  • ipV4FirewallSettings IPv4FirewallSettings
  • querypoolConnectionMode string (values: All, ReadOnly): 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 operationsall - indicates that the read-write server can participate in query operationsSpecifying readOnly when capacity is 1 results in error.

AnalysisServicesServerUpdateParameters

• AnalysisServicesServerUpdateParameters object: Provision request specification
  • properties AnalysisServicesServerMutableProperties
  • sku ResourceSku
  • tags object: Key-value pairs of additional provisioning properties.

AnalysisServicesServers

• AnalysisServicesServers object: An array of Analysis Services resources.
  • value required array: An array of Analysis Services resources.
    • items AnalysisServicesServer

CheckServerNameAvailabilityParameters

• CheckServerNameAvailabilityParameters object: Details of server name request body.
  • name string: Name for checking availability.
  • type string: The resource type of azure analysis services.

CheckServerNameAvailabilityResult

• CheckServerNameAvailabilityResult object: The checking result of server name availability.
  • message string: The detailed message of the request unavailability.
  • nameAvailable boolean: Indicator of available of the server name.
  • reason string: The reason of unavailability.

ErrorResponse

• ErrorResponse object: Describes the format of Error response.
  • code string: Error code
  • message string: Error message indicating why the operation failed.

GatewayDetails

• GatewayDetails object: The gateway details.
  • dmtsClusterUri string: Uri of the DMTS cluster.
  • gatewayObjectId string: Gateway object id from in the DMTS cluster for the gateway resource.
  • gatewayResourceId string: Gateway resource to be associated with the server.

GatewayError

• GatewayError object: Detail of gateway errors.
  • code string: Error code of list gateway.
  • message string: Error message of list gateway.

GatewayListStatusError

• GatewayListStatusError object: Status of gateway is error.
  • error GatewayError

GatewayListStatusLive

• GatewayListStatusLive object: Status of gateway is live.
  • status string (values: Live): Live message of list gateway.

IPv4FirewallRule

• IPv4FirewallRule object: The detail of firewall rule.
  • firewallRuleName string: The rule name.
  • rangeEnd string: The end range of IPv4.
  • rangeStart string: The start range of IPv4.

IPv4FirewallSettings

• IPv4FirewallSettings object: An array of firewall rules.
  • enablePowerBIService boolean: The indicator of enabling PBI service.
  • firewallRules array: An array of firewall rules.
    • items IPv4FirewallRule

Operation

• Operation object: A Consumption REST API operation.
  • display object: The object that represents the operation.
    • operation string: Operation type: Read, write, delete, etc.
    • provider string: Service provider: Microsoft.Consumption.
    • resource string: Resource on which the operation is performed: UsageDetail, etc.
  • name string: Operation name: {provider}/{resource}/{operation}.

OperationListResult

• OperationListResult object: Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.
  • nextLink string: URL to get the next set of operation list results if there are any.
  • value array: List of analysis services operations supported by the Microsoft.AnalysisServices resource provider.
    • items Operation

OperationStatus

• OperationStatus object: The status of operation.
  • endTime string: The end time of the operation.
  • error ErrorResponse
  • id string: The operation Id.
  • name string: The operation name.
  • startTime string: The start time of the operation.
  • status string: The status of the operation.

Resource

• Resource object: Represents an instance of an Analysis Services resource.
  • id string: An identifier that represents the Analysis Services resource.
  • location required string: Location of the Analysis Services resource.
  • name string: The name of the Analysis Services resource.
  • sku required ResourceSku
  • tags object: Key-value pairs of additional resource provisioning properties.
  • type string: The type of the Analysis Services resource.

ResourceSku

• ResourceSku object: Represents the SKU name and Azure pricing tier for Analysis Services resource.
  • capacity integer: The number of instances in the read only query pool.
  • name required string: Name of the SKU level.
  • tier string (values: Development, Basic, Standard): The name of the Azure pricing tier to which the SKU applies.

ServerAdministrators

• ServerAdministrators object: An array of administrator user identities.
  • members array: An array of administrator user identities.
    • items string: The UPN of the user. For example: [email protected].

SkuDetailsForExistingResource

• SkuDetailsForExistingResource object: An object that represents SKU details for existing resources.
  • sku ResourceSku

SkuEnumerationForExistingResourceResult

• SkuEnumerationForExistingResourceResult object: An object that represents enumerating SKUs for existing resources.
  • value array: The collection of available SKUs for existing resources.
    • items SkuDetailsForExistingResource

SkuEnumerationForNewResourceResult

• SkuEnumerationForNewResourceResult object: An object that represents enumerating SKUs for new resources.
  • value array: The collection of available SKUs for new resources.
    • items ResourceSku