Module azure.analysisservices
ballerinax/azure.analysisservices Ballerina library
1.3.2
Overview
The Azure Analysis Services API v2017-08-01 connector(https://azure.microsoft.com/en-us/services/analysis-services/) 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.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
- Create an Azure account
- Create an Azure Analysis Services account
- Obtain tokens
- Use this guide to obtain the credentials which are needed to create the <ACCESS_TOKEN>
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|errorGets 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
- AnalysisServicesServer|error - OK. The operation was successful.
serversCreate
Isolated FunctionRemote Function
function serversCreate(string resourceGroupName, string serverName, string apiVersion, string subscriptionId, AnalysisServicesServer payload) returns AnalysisServicesServer|errorProvisions 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.
- payload AnalysisServicesServer - Contains the information used to provision the Analysis Services server.
Return Type
- AnalysisServicesServer|error - OK. The operation completed successfully.
serversDelete
Isolated FunctionRemote Function
function serversDelete(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|errorDeletes 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.
serversUpdate
Isolated FunctionRemote Function
function serversUpdate(string resourceGroupName, string serverName, string apiVersion, string subscriptionId, AnalysisServicesServerUpdateParameters payload) returns AnalysisServicesServer|errorUpdates 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.
- payload AnalysisServicesServerUpdateParameters - Request object that contains the updated information for the server.
Return Type
serversSuspend
Isolated FunctionRemote Function
function serversSuspend(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|errorSuspends 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.
serversResume
Isolated FunctionRemote Function
function serversResume(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|errorResumes 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.
serversListbyresourcegroup
Isolated FunctionRemote Function
function serversListbyresourcegroup(string resourceGroupName, string apiVersion, string subscriptionId) returns AnalysisServicesServers|errorGets 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|errorLists 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|errorLists 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|errorLists 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|errorReturn 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
- GatewayListStatusLive|error - OK.
serversDissociategateway
Isolated FunctionRemote Function
function serversDissociategateway(string resourceGroupName, string serverName, string apiVersion, string subscriptionId) returns Response|errorDissociates 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.
serversChecknameavailability
Isolated FunctionRemote Function
function serversChecknameavailability(string location, string apiVersion, string subscriptionId, CheckServerNameAvailabilityParameters payload) returns CheckServerNameAvailabilityResult|errorCheck 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.
- payload CheckServerNameAvailabilityParameters - Contains the information used to provision the Analysis Services server.
Return Type
- CheckServerNameAvailabilityResult|error - OK. The request has succeeded.
serversListoperationresults
Isolated FunctionRemote Function
function serversListoperationresults(string location, string operationId, string apiVersion, string subscriptionId) returns Response|errorList 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.
serversListoperationstatuses
Isolated FunctionRemote Function
function serversListoperationstatuses(string location, string operationId, string apiVersion, string subscriptionId) returns OperationStatus|errorList 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
- OperationStatus|error - OK. The operation completed.
operationsList
Isolated FunctionRemote Function
function operationsList(string apiVersion) returns OperationListResult|errorLists all of the available consumption REST API operations.
Parameters
- apiVersion string - The client API version.
Return Type
- OperationListResult|error - OK. The request has succeeded.
Records
azure.analysisservices: AnalysisServicesServerMutableProperties
An object that represents a set of mutable Analysis Services resource properties.
Fields
- asAdministrators? ServerAdministrators - An array of administrator user identities.
- backupBlobContainerUri? string - The SAS container URI to the backup container.
- gatewayDetails? GatewayDetails - The gateway details.
- ipV4FirewallSettings? IPv4FirewallSettings - An array of firewall rules.
- 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
- value AnalysisServicesServer[] - An array of Analysis Services resources.
azure.analysisservices: AnalysisServicesServerUpdateParameters
Provision request specification
Fields
- sku? ResourceSku - Represents the SKU name and Azure pricing tier for Analysis Services resource.
- properties? AnalysisServicesServerMutableProperties - An object that represents a set of mutable Analysis Services resource 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
- proxy? ProxyConfig - Proxy server related options
azure.analysisservices: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- 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-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- 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
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- 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.
- details? ErrorDetail[] - The error details.
- additionalInfo? ErrorAdditionalInfo[] - The error additional info.
azure.analysisservices: ErrorResponse
Describes the format of Error response.
Fields
- 'error? ErrorDetail - The error detail.
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
- 'error? GatewayError -
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
- firewallRules? IPv4FirewallRule[] - An array of firewall rules.
- 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.
- dimensions? MetricDimensions[] - The dimensions of metric.
azure.analysisservices: Operation
A Consumption REST API operation.
Fields
- name? string - Operation name: {provider}/{resource}/{operation}.
- display? OperationDisplay - The object that represents the operation.
- origin? string - The origin
- 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.
- nextLink? string - URL to get the next set of operation list results if there are any.
azure.analysisservices: OperationProperties
Additional properties to expose performance metrics to shoebox.
Fields
- serviceSpecification? OperationPropertiesServicespecification - Performance metrics to shoebox.
azure.analysisservices: OperationPropertiesServicespecification
Performance metrics to shoebox.
Fields
- metricSpecifications? MetricSpecifications[] - The metric specifications.
- logSpecifications? LogSpecifications[] - The log specifications.
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.
- 'error? ErrorDetail - The error detail.
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.
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
- value? SkuDetailsForExistingResource[] - The collection of available SKUs for existing resources.
azure.analysisservices: SkuEnumerationForNewResourceResult
An object that represents enumerating SKUs for new resources.
Fields
- value? ResourceSku[] - The collection of available SKUs for new resources.
Simple name reference types
azure.analysisservices: GatewayError
GatewayError
The error detail.
azure.analysisservices: AnalysisServicesServer
AnalysisServicesServer
Represents an instance of an Analysis Services resource.
azure.analysisservices: AnalysisServicesServerProperties
AnalysisServicesServerProperties
Properties of Analysis Services resource.