@azure/arm-powerbidedicated package

Classes

Interfaces

AutoScaleVCore	Represents an instance of an auto scale v-core resource.
AutoScaleVCoreMutableProperties	An object that represents a set of mutable auto scale v-core resource properties.
AutoScaleVCoreProperties	Properties of an auto scale v-core resource.
AutoScaleVCoreSku	Represents the SKU name and Azure pricing tier for auto scale v-core resource.
AutoScaleVCoreUpdateParameters	Update request specification
AutoScaleVCoresCreateOptionalParams	Optional parameters.
AutoScaleVCoresDeleteOptionalParams	Optional parameters.
AutoScaleVCoresGetOptionalParams	Optional parameters.
AutoScaleVCoresListByResourceGroupOptionalParams	Optional parameters.
AutoScaleVCoresListBySubscriptionOptionalParams	Optional parameters.
AutoScaleVCoresOperations	Interface representing a AutoScaleVCores operations.
AutoScaleVCoresUpdateOptionalParams	Optional parameters.
CapacitiesCheckNameAvailabilityOptionalParams	Optional parameters.
CapacitiesCreateOptionalParams	Optional parameters.
CapacitiesDeleteOptionalParams	Optional parameters.
CapacitiesGetDetailsOptionalParams	Optional parameters.
CapacitiesListByResourceGroupOptionalParams	Optional parameters.
CapacitiesListOptionalParams	Optional parameters.
CapacitiesListSkusForCapacityOptionalParams	Optional parameters.
CapacitiesListSkusOptionalParams	Optional parameters.
CapacitiesOperations	Interface representing a Capacities operations.
CapacitiesResumeOptionalParams	Optional parameters.
CapacitiesSuspendOptionalParams	Optional parameters.
CapacitiesUpdateOptionalParams	Optional parameters.
CapacitySku	Represents the SKU name and Azure pricing tier for PowerBI Dedicated capacity resource.
CheckCapacityNameAvailabilityParameters	Details of capacity name request body.
CheckCapacityNameAvailabilityResult	The checking result of capacity name availability.
DedicatedCapacity	Represents an instance of a Dedicated Capacity resource.
DedicatedCapacityAdministrators	An array of administrator user identities
DedicatedCapacityMutableProperties	An object that represents a set of mutable Dedicated capacity resource properties.
DedicatedCapacityProperties	Properties of Dedicated Capacity resource.
DedicatedCapacityUpdateParameters	Provision request specification
ErrorResponse	The error object
LogSpecification	Log specification for exposing diagnostic logs to shoebox.
MetricSpecification	Metric specification for exposing performance metrics to shoebox.
MetricSpecificationDimensionsItem	model interface MetricSpecificationDimensionsItem
Operation	Capacities REST API operation.
OperationProperties	Additional properties to expose performance metrics to shoebox.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PowerBIDedicatedOptionalParams	Optional parameters for the client.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
ServiceSpecification	Service specification for exposing performance metrics to shoebox.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SkuDetailsForExistingResource	An object that represents SKU details for existing resources
SkuEnumerationForExistingResourceResult	An object that represents enumerating SKUs for existing resources
SkuEnumerationForNewResourceResult	An object that represents enumerating SKUs for new resources
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

AzureSupportedClouds	The supported values for cloud setting as a string literal type
CapacityProvisioningState	The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning. KnownCapacityProvisioningState can be used interchangeably with CapacityProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Deleting Succeeded Failed Paused Suspended Provisioning Updating Suspending Pausing Resuming Preparing Scaling
CapacitySkuTier	The name of the Azure pricing tier to which the SKU applies. KnownCapacitySkuTier can be used interchangeably with CapacitySkuTier, this enum contains the known values that the service supports. Known values supported by the service PBIE_Azure Premium AutoPremiumHost
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
Mode	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More KnownMode can be used interchangeably with Mode, this enum contains the known values that the service supports. Known values supported by the service Gen1 Gen2
State	The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service Deleting Succeeded Failed Paused Suspended Provisioning Updating Suspending Pausing Resuming Preparing Scaling
VCoreProvisioningState	The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning. KnownVCoreProvisioningState can be used interchangeably with VCoreProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded
VCoreSkuTier	The name of the Azure pricing tier to which the SKU applies. KnownVCoreSkuTier can be used interchangeably with VCoreSkuTier, this enum contains the known values that the service supports. Known values supported by the service AutoScale

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownCapacityProvisioningState	The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning.
KnownCapacitySkuTier	The name of the Azure pricing tier to which the SKU applies.
KnownCreatedByType	The kind of entity that created the resource.
KnownMode	Specifies the generation of the Power BI Embedded capacity. If no value is specified, the default value 'Gen2' is used. Learn More
KnownState	The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning.
KnownVCoreProvisioningState	The current deployment state of an auto scale v-core resource. The provisioningState is to indicate states for resource provisioning.
KnownVCoreSkuTier	The name of the Azure pricing tier to which the SKU applies.
KnownVersions	The available API versions.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(PowerBIDedicated, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(PowerBIDedicated, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: PowerBIDedicated, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: PowerBIDedicated

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-powerbidedicated package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(PowerBIDedicated, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback