Servers interface
Interface representing a Servers.
Methods
Method Details
beginCreate(string, string, AnalysisServicesServer, ServersCreateOptionalParams)
Provisions the specified Analysis Services server based on the configuration specified in the request.
function beginCreate(resourceGroupName: string, serverName: string, serverParameters: AnalysisServicesServer, options?: ServersCreateOptionalParams): Promise<PollerLike<PollOperationState<AnalysisServicesServer>, AnalysisServicesServer>>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.
- serverParameters
- AnalysisServicesServer
Contains the information used to provision the Analysis Services server.
- options
- ServersCreateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<AnalysisServicesServer>, AnalysisServicesServer>>
beginCreateAndWait(string, string, AnalysisServicesServer, ServersCreateOptionalParams)
Provisions the specified Analysis Services server based on the configuration specified in the request.
function beginCreateAndWait(resourceGroupName: string, serverName: string, serverParameters: AnalysisServicesServer, options?: ServersCreateOptionalParams): Promise<AnalysisServicesServer>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.
- serverParameters
- AnalysisServicesServer
Contains the information used to provision the Analysis Services server.
- options
- ServersCreateOptionalParams
The options parameters.
Returns
Promise<AnalysisServicesServer>
beginDelete(string, string, ServersDeleteOptionalParams)
Deletes the specified Analysis Services server.
function beginDelete(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- ServersDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, ServersDeleteOptionalParams)
Deletes the specified Analysis Services server.
function beginDeleteAndWait(resourceGroupName: string, serverName: string, options?: ServersDeleteOptionalParams): Promise<void>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.
- options
- ServersDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginResume(string, string, ServersResumeOptionalParams)
Resumes operation of the specified Analysis Services server instance.
function beginResume(resourceGroupName: string, serverName: string, options?: ServersResumeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- ServersResumeOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResumeAndWait(string, string, ServersResumeOptionalParams)
Resumes operation of the specified Analysis Services server instance.
function beginResumeAndWait(resourceGroupName: string, serverName: string, options?: ServersResumeOptionalParams): Promise<void>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.
- options
- ServersResumeOptionalParams
The options parameters.
Returns
Promise<void>
beginSuspend(string, string, ServersSuspendOptionalParams)
Suspends operation of the specified Analysis Services server instance.
function beginSuspend(resourceGroupName: string, serverName: string, options?: ServersSuspendOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>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.
- options
- ServersSuspendOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginSuspendAndWait(string, string, ServersSuspendOptionalParams)
Suspends operation of the specified Analysis Services server instance.
function beginSuspendAndWait(resourceGroupName: string, serverName: string, options?: ServersSuspendOptionalParams): Promise<void>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.
- options
- ServersSuspendOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, AnalysisServicesServerUpdateParameters, ServersUpdateOptionalParams)
Updates the current state of the specified Analysis Services server.
function beginUpdate(resourceGroupName: string, serverName: string, serverUpdateParameters: AnalysisServicesServerUpdateParameters, options?: ServersUpdateOptionalParams): Promise<PollerLike<PollOperationState<AnalysisServicesServer>, AnalysisServicesServer>>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.
- serverUpdateParameters
- AnalysisServicesServerUpdateParameters
Request object that contains the updated information for the server.
- options
- ServersUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<AnalysisServicesServer>, AnalysisServicesServer>>
beginUpdateAndWait(string, string, AnalysisServicesServerUpdateParameters, ServersUpdateOptionalParams)
Updates the current state of the specified Analysis Services server.
function beginUpdateAndWait(resourceGroupName: string, serverName: string, serverUpdateParameters: AnalysisServicesServerUpdateParameters, options?: ServersUpdateOptionalParams): Promise<AnalysisServicesServer>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.
- serverUpdateParameters
- AnalysisServicesServerUpdateParameters
Request object that contains the updated information for the server.
- options
- ServersUpdateOptionalParams
The options parameters.
Returns
Promise<AnalysisServicesServer>
checkNameAvailability(string, CheckServerNameAvailabilityParameters, ServersCheckNameAvailabilityOptionalParams)
Check the name availability in the target location.
function checkNameAvailability(location: string, serverParameters: CheckServerNameAvailabilityParameters, options?: ServersCheckNameAvailabilityOptionalParams): Promise<CheckServerNameAvailabilityResult>Parameters
- location
-
string
The region name which the operation will lookup into.
- serverParameters
- CheckServerNameAvailabilityParameters
Contains the information used to provision the Analysis Services server.
The options parameters.
Returns
Promise<CheckServerNameAvailabilityResult>
dissociateGateway(string, string, ServersDissociateGatewayOptionalParams)
Dissociates a Unified Gateway associated with the server.
function dissociateGateway(resourceGroupName: string, serverName: string, options?: ServersDissociateGatewayOptionalParams): Promise<void>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.
The options parameters.
Returns
Promise<void>
getDetails(string, string, ServersGetDetailsOptionalParams)
Gets details about the specified Analysis Services server.
function getDetails(resourceGroupName: string, serverName: string, options?: ServersGetDetailsOptionalParams): Promise<AnalysisServicesServer>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.
- options
- ServersGetDetailsOptionalParams
The options parameters.
Returns
Promise<AnalysisServicesServer>
list(ServersListOptionalParams)
Lists all the Analysis Services servers for the given subscription.
function list(options?: ServersListOptionalParams): PagedAsyncIterableIterator<AnalysisServicesServer, AnalysisServicesServer[], PageSettings>Parameters
- options
- ServersListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ServersListByResourceGroupOptionalParams)
Gets all the Analysis Services servers for the given resource group.
function listByResourceGroup(resourceGroupName: string, options?: ServersListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AnalysisServicesServer, AnalysisServicesServer[], PageSettings>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.
The options parameters.
Returns
listGatewayStatus(string, string, ServersListGatewayStatusOptionalParams)
Return the gateway status of the specified Analysis Services server instance.
function listGatewayStatus(resourceGroupName: string, serverName: string, options?: ServersListGatewayStatusOptionalParams): Promise<GatewayListStatusLive>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.
The options parameters.
Returns
Promise<GatewayListStatusLive>
listOperationResults(string, string, ServersListOperationResultsOptionalParams)
List the result of the specified operation.
function listOperationResults(location: string, operationId: string, options?: ServersListOperationResultsOptionalParams): Promise<void>Parameters
- location
-
string
The region name which the operation will lookup into.
- operationId
-
string
The target operation Id.
The options parameters.
Returns
Promise<void>
listOperationStatuses(string, string, ServersListOperationStatusesOptionalParams)
List the status of operation.
function listOperationStatuses(location: string, operationId: string, options?: ServersListOperationStatusesOptionalParams): Promise<OperationStatus>Parameters
- location
-
string
The region name which the operation will lookup into.
- operationId
-
string
The target operation Id.
The options parameters.
Returns
Promise<OperationStatus>
listSkusForExisting(string, string, ServersListSkusForExistingOptionalParams)
Lists eligible SKUs for an Analysis Services resource.
function listSkusForExisting(resourceGroupName: string, serverName: string, options?: ServersListSkusForExistingOptionalParams): Promise<SkuEnumerationForExistingResourceResult>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.
The options parameters.
Returns
listSkusForNew(ServersListSkusForNewOptionalParams)
Lists eligible SKUs for Analysis Services resource provider.
function listSkusForNew(options?: ServersListSkusForNewOptionalParams): Promise<SkuEnumerationForNewResourceResult>Parameters
The options parameters.
Returns
Promise<SkuEnumerationForNewResourceResult>