Capacities interface
Interface representing a Capacities.
Methods
Method Details
beginCreate(string, string, DedicatedCapacity, CapacitiesCreateOptionalParams)
Provisions the specified Dedicated capacity based on the configuration specified in the request.
function beginCreate(resourceGroupName: string, dedicatedCapacityName: string, capacityParameters: DedicatedCapacity, options?: CapacitiesCreateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedCapacity>, DedicatedCapacity>>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.
- capacityParameters
- DedicatedCapacity
Contains the information used to provision the Dedicated capacity.
- options
- CapacitiesCreateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DedicatedCapacity>, DedicatedCapacity>>
beginCreateAndWait(string, string, DedicatedCapacity, CapacitiesCreateOptionalParams)
Provisions the specified Dedicated capacity based on the configuration specified in the request.
function beginCreateAndWait(resourceGroupName: string, dedicatedCapacityName: string, capacityParameters: DedicatedCapacity, options?: CapacitiesCreateOptionalParams): Promise<DedicatedCapacity>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.
- capacityParameters
- DedicatedCapacity
Contains the information used to provision the Dedicated capacity.
- options
- CapacitiesCreateOptionalParams
The options parameters.
Returns
Promise<DedicatedCapacity>
beginDelete(string, string, CapacitiesDeleteOptionalParams)
Deletes the specified Dedicated capacity.
function beginDelete(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- options
- CapacitiesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, CapacitiesDeleteOptionalParams)
Deletes the specified Dedicated capacity.
function beginDeleteAndWait(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- options
- CapacitiesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginResume(string, string, CapacitiesResumeOptionalParams)
Resumes operation of the specified Dedicated capacity instance.
function beginResume(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesResumeOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- options
- CapacitiesResumeOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResumeAndWait(string, string, CapacitiesResumeOptionalParams)
Resumes operation of the specified Dedicated capacity instance.
function beginResumeAndWait(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesResumeOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- options
- CapacitiesResumeOptionalParams
The options parameters.
Returns
Promise<void>
beginSuspend(string, string, CapacitiesSuspendOptionalParams)
Suspends operation of the specified dedicated capacity instance.
function beginSuspend(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesSuspendOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- options
- CapacitiesSuspendOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginSuspendAndWait(string, string, CapacitiesSuspendOptionalParams)
Suspends operation of the specified dedicated capacity instance.
function beginSuspendAndWait(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesSuspendOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- options
- CapacitiesSuspendOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, DedicatedCapacityUpdateParameters, CapacitiesUpdateOptionalParams)
Updates the current state of the specified Dedicated capacity.
function beginUpdate(resourceGroupName: string, dedicatedCapacityName: string, capacityUpdateParameters: DedicatedCapacityUpdateParameters, options?: CapacitiesUpdateOptionalParams): Promise<PollerLike<PollOperationState<DedicatedCapacity>, DedicatedCapacity>>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- capacityUpdateParameters
- DedicatedCapacityUpdateParameters
Request object that contains the updated information for the capacity.
- options
- CapacitiesUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DedicatedCapacity>, DedicatedCapacity>>
beginUpdateAndWait(string, string, DedicatedCapacityUpdateParameters, CapacitiesUpdateOptionalParams)
Updates the current state of the specified Dedicated capacity.
function beginUpdateAndWait(resourceGroupName: string, dedicatedCapacityName: string, capacityUpdateParameters: DedicatedCapacityUpdateParameters, options?: CapacitiesUpdateOptionalParams): Promise<DedicatedCapacity>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- capacityUpdateParameters
- DedicatedCapacityUpdateParameters
Request object that contains the updated information for the capacity.
- options
- CapacitiesUpdateOptionalParams
The options parameters.
Returns
Promise<DedicatedCapacity>
checkNameAvailability(string, CheckCapacityNameAvailabilityParameters, CapacitiesCheckNameAvailabilityOptionalParams)
Check the name availability in the target location.
function checkNameAvailability(location: string, capacityParameters: CheckCapacityNameAvailabilityParameters, options?: CapacitiesCheckNameAvailabilityOptionalParams): Promise<CheckCapacityNameAvailabilityResult>Parameters
- location
-
string
The region name which the operation will lookup into.
- capacityParameters
- CheckCapacityNameAvailabilityParameters
The name of the capacity.
The options parameters.
Returns
Promise<CheckCapacityNameAvailabilityResult>
getDetails(string, string, CapacitiesGetDetailsOptionalParams)
Gets details about the specified dedicated capacity.
function getDetails(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesGetDetailsOptionalParams): Promise<DedicatedCapacity>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.
The options parameters.
Returns
Promise<DedicatedCapacity>
list(CapacitiesListOptionalParams)
Lists all the Dedicated capacities for the given subscription.
function list(options?: CapacitiesListOptionalParams): PagedAsyncIterableIterator<DedicatedCapacity, DedicatedCapacity[], PageSettings>Parameters
- options
- CapacitiesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, CapacitiesListByResourceGroupOptionalParams)
Gets all the Dedicated capacities for the given resource group.
function listByResourceGroup(resourceGroupName: string, options?: CapacitiesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DedicatedCapacity, DedicatedCapacity[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
The options parameters.
Returns
listSkus(CapacitiesListSkusOptionalParams)
Lists eligible SKUs for PowerBI Dedicated resource provider.
function listSkus(options?: CapacitiesListSkusOptionalParams): Promise<SkuEnumerationForNewResourceResult>Parameters
- options
- CapacitiesListSkusOptionalParams
The options parameters.
Returns
Promise<SkuEnumerationForNewResourceResult>
listSkusForCapacity(string, string, CapacitiesListSkusForCapacityOptionalParams)
Lists eligible SKUs for a PowerBI Dedicated resource.
function listSkusForCapacity(resourceGroupName: string, dedicatedCapacityName: string, options?: CapacitiesListSkusForCapacityOptionalParams): Promise<SkuEnumerationForExistingResourceResult>Parameters
- resourceGroupName
-
string
The name of the Azure Resource group of which a given PowerBIDedicated capacity is part. This name must be at least 1 character in length, and no more than 90.
- dedicatedCapacityName
-
string
The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
The options parameters.