@datafire/azure_powerbidedicated NPM

@datafire/azure_powerbidedicated

Client library for PowerBIDedicated

Installation and Usage

npm install --save @datafire/azure_powerbidedicated

let azure_powerbidedicated = require('@datafire/azure_powerbidedicated').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

PowerBI Dedicated Web API provides a RESTful set of web services that enables users to create, retrieve, update, and delete Power BI dedicated capacities

Actions

Operations_List

Lists all of the available PowerBIDedicated REST API operations.

azure_powerbidedicated.Operations_List({
  "api-version": ""
}, context)

Input

input object
- api-version required string: The client API version.

Output

output OperationListResult

Capacities_List

Lists all the Dedicated capacities for the given subscription.

azure_powerbidedicated.Capacities_List({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedCapacities

Capacities_CheckNameAvailability

Check the name availability in the target location.

azure_powerbidedicated.Capacities_CheckNameAvailability({
  "location": "",
  "capacityParameters": {},
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- location required string: The region name which the operation will lookup into.
- capacityParameters required CheckCapacityNameAvailabilityParameters
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output CheckCapacityNameAvailabilityResult

Capacities_ListSkus

Lists eligible SKUs for PowerBI Dedicated resource provider.

azure_powerbidedicated.Capacities_ListSkus({
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output SkuEnumerationForNewResourceResult

Capacities_ListByResourceGroup

Gets all the Dedicated capacities for the given resource group.

azure_powerbidedicated.Capacities_ListByResourceGroup({
  "resourceGroupName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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.
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedCapacities

Capacities_Delete

Deletes the specified Dedicated capacity.

azure_powerbidedicated.Capacities_Delete({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Capacities_GetDetails

Gets details about the specified dedicated capacity.

azure_powerbidedicated.Capacities_GetDetails({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedCapacity

Capacities_Update

Updates the current state of the specified Dedicated capacity.

azure_powerbidedicated.Capacities_Update({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "capacityUpdateParameters": {},
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- capacityUpdateParameters required DedicatedCapacityUpdateParameters
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedCapacity

Capacities_Create

Provisions the specified Dedicated capacity based on the configuration specified in the request.

azure_powerbidedicated.Capacities_Create({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "capacityParameters": {
    "location": "",
    "sku": {
      "name": ""
    }
  },
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the Dedicated capacity. It must be a minimum of 3 characters, and a maximum of 63.
- capacityParameters required DedicatedCapacity
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output DedicatedCapacity

Capacities_Resume

Resumes operation of the specified Dedicated capacity instance.

azure_powerbidedicated.Capacities_Resume({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Capacities_ListSkusForCapacity

Lists eligible SKUs for a PowerBI Dedicated resource.

azure_powerbidedicated.Capacities_ListSkusForCapacity({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

output SkuEnumerationForExistingResourceResult

Capacities_Suspend

Suspends operation of the specified dedicated capacity instance.

azure_powerbidedicated.Capacities_Suspend({
  "resourceGroupName": "",
  "dedicatedCapacityName": "",
  "api-version": "",
  "subscriptionId": ""
}, context)

Input

input object
- resourceGroupName required 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 required string: The name of the Dedicated capacity. It must be at least 3 characters in length, and no more than 63.
- api-version required string: The client API version.
- subscriptionId required string: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Output

Output schema unknown

Definitions

CheckCapacityNameAvailabilityParameters

CheckCapacityNameAvailabilityParameters object: Details of capacity name request body.
- name string: Name for checking availability.
- type string: The resource type of PowerBI dedicated.

CheckCapacityNameAvailabilityResult

CheckCapacityNameAvailabilityResult object: The checking result of capacity name availability.
- message string: The detailed message of the request unavailability.
- nameAvailable boolean: Indicator of availability of the capacity name.
- reason string: The reason of unavailability.

DedicatedCapacities

DedicatedCapacities object: An array of Dedicated capacities resources.
- value required array: An array of Dedicated capacities resources.
  - items DedicatedCapacity

DedicatedCapacity

DedicatedCapacity object: Represents an instance of a Dedicated Capacity resource.
- properties DedicatedCapacityProperties
- id string: An identifier that represents the PowerBI Dedicated resource.
- location required string: Location of the PowerBI Dedicated resource.
- name string: The name of the PowerBI Dedicated resource.
- sku required ResourceSku
- tags object: Key-value pairs of additional resource provisioning properties.
- type string: The type of the PowerBI Dedicated resource.

DedicatedCapacityAdministrators

DedicatedCapacityAdministrators object: An array of administrator user identities
- members array: An array of administrator user identities.
  - items string: The UPN of the user. For example: johnsmith@contoso.com.

DedicatedCapacityMutableProperties

DedicatedCapacityMutableProperties object: An object that represents a set of mutable Dedicated capacity resource properties.
- administration DedicatedCapacityAdministrators

DedicatedCapacityProperties

DedicatedCapacityProperties object: Properties of Dedicated Capacity resource.
- provisioningState string (values: Deleting, Succeeded, Failed, Paused, Suspended, Provisioning, Updating, Suspending, Pausing, Resuming, Preparing, Scaling): The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning.
- state string (values: Deleting, Succeeded, Failed, Paused, Suspended, Provisioning, Updating, Suspending, Pausing, Resuming, Preparing, Scaling): The current state of PowerBI Dedicated resource. The state is to indicate more states outside of resource provisioning.
- administration DedicatedCapacityAdministrators

DedicatedCapacityUpdateParameters

DedicatedCapacityUpdateParameters object: Provision request specification
- properties DedicatedCapacityMutableProperties
- sku ResourceSku
- tags object: Key-value pairs of additional provisioning properties.

ErrorResponse

ErrorResponse object: Describes the format of Error response.
- code string: Error code
- message string: Error message indicating why the operation failed.

Operation

Operation object: Capacities REST API operation.
- display object: The object that represents the operation.
  - operation string: Operation type: create, update, delete, etc.
  - provider string: Service provider: Microsoft.PowerBIDedicated.
  - resource string: Resource on which the operation is performed: capacity, etc.
- name string: Operation name: {provider}/{resource}/{operation}.

OperationListResult

OperationListResult object: Result listing capacities. It contains a list of operations and a URL link to get the next set of results.
- nextLink string: URL to get the next set of operation list results if there are any.
- value array: List of capacities supported by the Microsoft.PowerBIDedicated resource provider.
  - items Operation

Resource

Resource object: Represents an instance of an PowerBI Dedicated resource.
- id string: An identifier that represents the PowerBI Dedicated resource.
- location required string: Location of the PowerBI Dedicated resource.
- name string: The name of the PowerBI Dedicated resource.
- sku required ResourceSku
- tags object: Key-value pairs of additional resource provisioning properties.
- type string: The type of the PowerBI Dedicated resource.

ResourceSku

ResourceSku object: Represents the SKU name and Azure pricing tier for PowerBI Dedicated resource.
- name required string: Name of the SKU level.
- tier string (values: PBIE_Azure): The name of the Azure pricing tier to which the SKU applies.

SkuDetailsForExistingResource

SkuDetailsForExistingResource object: An object that represents SKU details for existing resources
- sku ResourceSku

SkuEnumerationForExistingResourceResult

SkuEnumerationForExistingResourceResult object: An object that represents enumerating SKUs for existing resources
- value array: The collection of available SKUs for existing resources
  - items SkuDetailsForExistingResource

SkuEnumerationForNewResourceResult

SkuEnumerationForNewResourceResult object: An object that represents enumerating SKUs for new resources
- value array: The collection of available SKUs for new resources
  - items ResourceSku

datafire

@infinitebrahmanuniverse/nolb-_datafire_az @everything-registry/sub-chunk-221

5.0.0

5 years ago

4.0.0

8 years ago

3.0.0

8 years ago