Ballerina library

azure.analysisservices

Module azure.analysisservices

OverviewPrerequisites

API

Client

Definitions

AnalysisServicesServerMutableProperties
AnalysisServicesServers
AnalysisServicesServerUpdateParameters
CheckServerNameAvailabilityParameters
CheckServerNameAvailabilityResult
ClientHttp1Settings
ConnectionConfig
ErrorAdditionalInfo
ErrorDetail
ErrorResponse
GatewayDetails
GatewayListStatusError
GatewayListStatusLive
IPv4FirewallRule
IPv4FirewallSettings
LogSpecifications
MetricDimensions
MetricSpecifications
Operation
OperationDisplay
OperationListResult
OperationProperties
OperationPropertiesServicespecification
OperationStatus
ProxyConfig
Resource
ResourceSku
ServerAdministrators
SkuDetailsForExistingResource
SkuEnumerationForExistingResourceResult
SkuEnumerationForNewResourceResult

ballerinax/azure.analysisservices Ballerina library

1.3.1

Overview

This is a generated connector from Azure Analysis Services API v2017-08-01 OpenAPI specification.

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.

Prerequisites

Clients

azure.analysisservices: Client

Isolated

This is a generated connector from Azure Analysis Services API v2017-08-01 OpenAPI specification. 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

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an Azure Analysis Services account and obtain OAuth tokens following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://management.azure.com/" - URL of the target service

serversGetdetails

Isolated FunctionRemote Function
function serversGetdetails(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns AnalysisServicesServer|error

Gets details about the specified Analysis Services server.

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

serversCreate

Isolated FunctionRemote Function
function serversCreate(string resourceGroupName, string serverName, string apiVersion, string subscriptionId, AnalysisServicesServer payload) returns AnalysisServicesServer|error

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

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

serversDelete

Isolated FunctionRemote Function
function serversDelete(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|error

Deletes the specified Analysis Services server.

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

serversUpdate

Isolated FunctionRemote Function
function serversUpdate(string resourceGroupName, string serverName, string apiVersion, string subscriptionId, AnalysisServicesServerUpdateParameters payload) returns AnalysisServicesServer|error

Updates the current state of the specified Analysis Services server.

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

serversSuspend

Isolated FunctionRemote Function
function serversSuspend(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|error

Suspends operation of the specified Analysis Services server instance.

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

serversResume

Isolated FunctionRemote Function
function serversResume(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|error

Resumes operation of the specified Analysis Services server instance.

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

serversListbyresourcegroup

Isolated FunctionRemote Function
function serversListbyresourcegroup(string resourceGroupName, string apiVersion, string subscriptionId) returns AnalysisServicesServers|error

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

Parameters
  • resourceGroupName 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.
  • apiVersion string - The client API version.
  • subscriptionId string - A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Return Type

serversList

Isolated FunctionRemote Function
function serversList(string apiVersion, string subscriptionId) returns AnalysisServicesServers|error

Lists all the Analysis Services servers for the given subscription.

Parameters
  • apiVersion string - The client API version.
  • subscriptionId string - A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Return Type

serversListskusfornew

Isolated FunctionRemote Function
function serversListskusfornew(string apiVersion, string subscriptionId) returns SkuEnumerationForNewResourceResult|error

Lists eligible SKUs for Analysis Services resource provider.

Parameters
  • apiVersion string - The client API version.
  • subscriptionId string - A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Return Type

serversListskusforexisting

Isolated FunctionRemote Function
function serversListskusforexisting(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns SkuEnumerationForExistingResourceResult|error

Lists eligible SKUs for an Analysis Services resource.

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

serversListgatewaystatus

Isolated FunctionRemote Function
function serversListgatewaystatus(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns GatewayListStatusLive|error

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

Parameters
  • resourceGroupName 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 string - The name of the Analysis Services server.
  • apiVersion string - The client API version.
  • subscriptionId string - A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Return Type

serversDissociategateway

Isolated FunctionRemote Function
function serversDissociategateway(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|error

Dissociates a Unified Gateway associated with the server.

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

serversChecknameavailability

Isolated FunctionRemote Function
function serversChecknameavailability(string location, string apiVersion, string subscriptionId, CheckServerNameAvailabilityParameters payload) returns CheckServerNameAvailabilityResult|error

Check the name availability in the target location.

Parameters
  • location string - The region name which the operation will lookup into.
  • apiVersion string - The client API version.
  • subscriptionId string - A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
Return Type

serversListoperationresults

Isolated FunctionRemote Function
function serversListoperationresults(string location, string operationId, string apiVersion, string subscriptionId) returns Response|error

List the result of the specified operation.

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

serversListoperationstatuses

Isolated FunctionRemote Function
function serversListoperationstatuses(string location, string operationId, string apiVersion, string subscriptionId) returns OperationStatus|error

List the status of operation.

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

operationsList

Isolated FunctionRemote Function
function operationsList(string apiVersion) returns OperationListResult|error

Lists all of the available consumption REST API operations.

Parameters
  • apiVersion string - The client API version.
Return Type

Records

azure.analysisservices: AnalysisServicesServerMutableProperties

An object that represents a set of mutable Analysis Services resource properties.

Fields
  • backupBlobContainerUri string? - The SAS container URI to the backup container.
  • querypoolConnectionMode string? - How the read-write server's participation in the query pool is controlled.<br/>It can have the following values: <ul><li>readOnly - indicates that the read-write server is intended not to participate in query operations</li><li>all - indicates that the read-write server can participate in query operations</li></ul>Specifying readOnly when capacity is 1 results in error.
  • managedMode int? - The managed mode of the server (0 = not managed, 1 = managed).
  • serverMonitorMode int? - The server monitor mode for AS server

azure.analysisservices: AnalysisServicesServers

An array of Analysis Services resources.

Fields

azure.analysisservices: AnalysisServicesServerUpdateParameters

Provision request specification

Fields
  • sku ResourceSku? - Represents the SKU name and Azure pricing tier for Analysis Services resource.
  • tags record {}? - Key-value pairs of additional provisioning properties.

azure.analysisservices: CheckServerNameAvailabilityParameters

Details of server name request body.

Fields
  • name string? - Name for checking availability.
  • 'type string? - The resource type of azure analysis services.

azure.analysisservices: CheckServerNameAvailabilityResult

The checking result of server name availability.

Fields
  • nameAvailable boolean? - Indicator of available of the server name.
  • reason string? - The reason of unavailability.
  • message string? - The detailed message of the request unavailability.

azure.analysisservices: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

azure.analysisservices: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

azure.analysisservices: ErrorAdditionalInfo

The resource management error additional info.

Fields
  • 'type string? - The additional info type.
  • info record {}? - The additional info.

azure.analysisservices: ErrorDetail

The error detail.

Fields
  • code string? - The error code.
  • message string? - The error message.
  • target string? - The error target.
  • subCode int? - The error sub code
  • httpStatusCode int? - The http status code
  • timeStamp string? - the timestamp for the error.

azure.analysisservices: ErrorResponse

Describes the format of Error response.

Fields

azure.analysisservices: GatewayDetails

The gateway details.

Fields
  • gatewayResourceId string? - Gateway resource to be associated with the server.
  • gatewayObjectId string? - Gateway object id from in the DMTS cluster for the gateway resource.
  • dmtsClusterUri string? - Uri of the DMTS cluster.

azure.analysisservices: GatewayListStatusError

Fields

azure.analysisservices: GatewayListStatusLive

Status of gateway is live.

Fields
  • status int? - Live message of list gateway. Status: 0 - Live

azure.analysisservices: IPv4FirewallRule

The detail of firewall rule.

Fields
  • firewallRuleName string? - The rule name.
  • rangeStart string? - The start range of IPv4.
  • rangeEnd string? - The end range of IPv4.

azure.analysisservices: IPv4FirewallSettings

An array of firewall rules.

Fields
  • enablePowerBIService boolean? - The indicator of enabling PBI service.

azure.analysisservices: LogSpecifications

The log metric specification for exposing performance metrics to shoebox.

Fields
  • name string? - The name of metric.
  • displayName string? - The displayed name of log.
  • blobDuration string? - The blob duration for the log.

azure.analysisservices: MetricDimensions

Metric dimension.

Fields
  • name string? - Dimension name.
  • displayName string? - Dimension display name.

azure.analysisservices: MetricSpecifications

Available operation metric specification for exposing performance metrics to shoebox.

Fields
  • name string? - The name of metric.
  • displayName string? - The displayed name of metric.
  • displayDescription string? - The displayed description of metric.
  • unit string? - The unit of the metric.
  • aggregationType string? - The aggregation type of metric.

azure.analysisservices: Operation

A Consumption REST API operation.

Fields
  • name string? - Operation name: {provider}/{resource}/{operation}.
  • properties OperationProperties? - Additional properties to expose performance metrics to shoebox.

azure.analysisservices: OperationDisplay

The object that represents the operation.

Fields
  • provider string? - Service provider: Microsoft.Consumption.
  • 'resource string? - Resource on which the operation is performed: UsageDetail, etc.
  • operation string? - Operation type: Read, write, delete, etc.
  • description string? - Description of the operation object.

azure.analysisservices: OperationListResult

Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.

Fields
  • value Operation[]? - List of analysis services operations supported by the Microsoft.AnalysisServices resource provider.

azure.analysisservices: OperationProperties

Additional properties to expose performance metrics to shoebox.

Fields

azure.analysisservices: OperationPropertiesServicespecification

Performance metrics to shoebox.

Fields

azure.analysisservices: OperationStatus

The status of operation.

Fields
  • id string? - The operation Id.
  • name string? - The operation name.
  • startTime string? - The start time of the operation.
  • endTime string? - The end time of the operation.
  • status string? - The status of the operation.

azure.analysisservices: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

azure.analysisservices: Resource

Represents an instance of an Analysis Services resource.

Fields
  • id string? - An identifier that represents the Analysis Services resource.
  • name string? - The name of the Analysis Services resource.
  • 'type string? - The type of the Analysis Services resource.
  • location string - Location of the Analysis Services resource.
  • sku ResourceSku - Represents the SKU name and Azure pricing tier for Analysis Services resource.
  • tags record {}? - Key-value pairs of additional resource provisioning properties.

azure.analysisservices: ResourceSku

Represents the SKU name and Azure pricing tier for Analysis Services resource.

Fields
  • name string - Name of the SKU level.
  • tier string? - The name of the Azure pricing tier to which the SKU applies.
  • capacity int(default 1) - The number of instances in the read only query pool.

azure.analysisservices: ServerAdministrators

An array of administrator user identities.

Fields
  • members string[]? - An array of administrator user identities.

azure.analysisservices: SkuDetailsForExistingResource

An object that represents SKU details for existing resources.

Fields
  • sku ResourceSku? - Represents the SKU name and Azure pricing tier for Analysis Services resource.
  • resourceType string? - The resource type.

azure.analysisservices: SkuEnumerationForExistingResourceResult

An object that represents enumerating SKUs for existing resources.

Fields

azure.analysisservices: SkuEnumerationForNewResourceResult

An object that represents enumerating SKUs for new resources.

Fields
  • value ResourceSku[]? - The collection of available SKUs for new resources.

Import

import ballerinax/azure.analysisservices;Copy

Other versions

1.3.1

1.3.01.2.0

Metadata

Released date: over 2 years ago

Version: 1.3.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

IT Operations/Cloud Services

Cost/Paid

Vendor/Microsoft

Contributors

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC