powerbiembedded

package
v11.2.1-beta+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2017 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package powerbiembedded implements the Azure ARM Powerbiembedded service API version 2016-01-29.

Client to manage your Power BI Embedded workspace collections and retrieve workspaces.

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Powerbiembedded
	DefaultBaseURI = "https://management.azure.com"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type AccessKeyName

type AccessKeyName string

AccessKeyName enumerates the values for access key name.

const (
	// Key1 specifies the key 1 state for access key name.
	Key1 AccessKeyName = "key1"
	// Key2 specifies the key 2 state for access key name.
	Key2 AccessKeyName = "key2"
)

type AzureSku

type AzureSku struct {
	Name *string `json:"name,omitempty"`
	Tier *string `json:"tier,omitempty"`
}

AzureSku is

type CheckNameReason

type CheckNameReason string

CheckNameReason enumerates the values for check name reason.

const (
	// Invalid specifies the invalid state for check name reason.
	Invalid CheckNameReason = "Invalid"
	// Unavailable specifies the unavailable state for check name reason.
	Unavailable CheckNameReason = "Unavailable"
)

type CheckNameRequest

type CheckNameRequest struct {
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

CheckNameRequest is

type CheckNameResponse

type CheckNameResponse struct {
	autorest.Response `json:"-"`
	NameAvailable     *bool           `json:"nameAvailable,omitempty"`
	Reason            CheckNameReason `json:"reason,omitempty"`
	Message           *string         `json:"message,omitempty"`
}

CheckNameResponse is

type CreateWorkspaceCollectionRequest

type CreateWorkspaceCollectionRequest struct {
	Location *string             `json:"location,omitempty"`
	Tags     *map[string]*string `json:"tags,omitempty"`
	Sku      *AzureSku           `json:"sku,omitempty"`
}

CreateWorkspaceCollectionRequest is

type Display

type Display struct {
	Provider    *string `json:"provider,omitempty"`
	Resource    *string `json:"resource,omitempty"`
	Operation   *string `json:"operation,omitempty"`
	Description *string `json:"description,omitempty"`
	Origin      *string `json:"origin,omitempty"`
}

Display is

type Error

type Error struct {
	Code    *string        `json:"code,omitempty"`
	Message *string        `json:"message,omitempty"`
	Target  *string        `json:"target,omitempty"`
	Details *[]ErrorDetail `json:"details,omitempty"`
}

Error is

type ErrorDetail

type ErrorDetail struct {
	Code    *string `json:"code,omitempty"`
	Message *string `json:"message,omitempty"`
	Target  *string `json:"target,omitempty"`
}

ErrorDetail is

type ManagementClient

type ManagementClient struct {
	autorest.Client
	BaseURI        string
	SubscriptionID string
}

ManagementClient is the base client for Powerbiembedded.

func New

func New(subscriptionID string) ManagementClient

New creates an instance of the ManagementClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, subscriptionID string) ManagementClient

NewWithBaseURI creates an instance of the ManagementClient client.

func (ManagementClient) GetAvailableOperations

func (client ManagementClient) GetAvailableOperations() (result OperationList, err error)

GetAvailableOperations indicates which operations can be performed by the Power BI Resource Provider.

func (ManagementClient) GetAvailableOperationsPreparer

func (client ManagementClient) GetAvailableOperationsPreparer() (*http.Request, error)

GetAvailableOperationsPreparer prepares the GetAvailableOperations request.

func (ManagementClient) GetAvailableOperationsResponder

func (client ManagementClient) GetAvailableOperationsResponder(resp *http.Response) (result OperationList, err error)

GetAvailableOperationsResponder handles the response to the GetAvailableOperations request. The method always closes the http.Response Body.

func (ManagementClient) GetAvailableOperationsSender

func (client ManagementClient) GetAvailableOperationsSender(req *http.Request) (*http.Response, error)

GetAvailableOperationsSender sends the GetAvailableOperations request. The method will close the http.Response Body if it receives an error.

type MigrateWorkspaceCollectionRequest

type MigrateWorkspaceCollectionRequest struct {
	TargetResourceGroup *string   `json:"targetResourceGroup,omitempty"`
	Resources           *[]string `json:"resources,omitempty"`
}

MigrateWorkspaceCollectionRequest is

type Operation

type Operation struct {
	Name    *string  `json:"name,omitempty"`
	Display *Display `json:"display,omitempty"`
}

Operation is

type OperationList

type OperationList struct {
	autorest.Response `json:"-"`
	Value             *[]Operation `json:"value,omitempty"`
}

OperationList is

type UpdateWorkspaceCollectionRequest

type UpdateWorkspaceCollectionRequest struct {
	Tags *map[string]*string `json:"tags,omitempty"`
	Sku  *AzureSku           `json:"sku,omitempty"`
}

UpdateWorkspaceCollectionRequest is

type Workspace

type Workspace struct {
	ID         *string                 `json:"id,omitempty"`
	Name       *string                 `json:"name,omitempty"`
	Type       *string                 `json:"type,omitempty"`
	Properties *map[string]interface{} `json:"properties,omitempty"`
}

Workspace is

type WorkspaceCollection

type WorkspaceCollection struct {
	autorest.Response `json:"-"`
	ID                *string                 `json:"id,omitempty"`
	Name              *string                 `json:"name,omitempty"`
	Type              *string                 `json:"type,omitempty"`
	Location          *string                 `json:"location,omitempty"`
	Tags              *map[string]*string     `json:"tags,omitempty"`
	Sku               *AzureSku               `json:"sku,omitempty"`
	Properties        *map[string]interface{} `json:"properties,omitempty"`
}

WorkspaceCollection is

type WorkspaceCollectionAccessKey

type WorkspaceCollectionAccessKey struct {
	KeyName AccessKeyName `json:"keyName,omitempty"`
}

WorkspaceCollectionAccessKey is

type WorkspaceCollectionAccessKeys

type WorkspaceCollectionAccessKeys struct {
	autorest.Response `json:"-"`
	Key1              *string `json:"key1,omitempty"`
	Key2              *string `json:"key2,omitempty"`
}

WorkspaceCollectionAccessKeys is

type WorkspaceCollectionList

type WorkspaceCollectionList struct {
	autorest.Response `json:"-"`
	Value             *[]WorkspaceCollection `json:"value,omitempty"`
}

WorkspaceCollectionList is

type WorkspaceCollectionsClient

type WorkspaceCollectionsClient struct {
	ManagementClient
}

WorkspaceCollectionsClient is the client to manage your Power BI Embedded workspace collections and retrieve workspaces.

func NewWorkspaceCollectionsClient

func NewWorkspaceCollectionsClient(subscriptionID string) WorkspaceCollectionsClient

NewWorkspaceCollectionsClient creates an instance of the WorkspaceCollectionsClient client.

func NewWorkspaceCollectionsClientWithBaseURI

func NewWorkspaceCollectionsClientWithBaseURI(baseURI string, subscriptionID string) WorkspaceCollectionsClient

NewWorkspaceCollectionsClientWithBaseURI creates an instance of the WorkspaceCollectionsClient client.

func (WorkspaceCollectionsClient) CheckNameAvailability

func (client WorkspaceCollectionsClient) CheckNameAvailability(location string, body CheckNameRequest) (result CheckNameResponse, err error)

CheckNameAvailability verify the specified Power BI Workspace Collection name is valid and not already in use.

location is azure location body is check name availability request

func (WorkspaceCollectionsClient) CheckNameAvailabilityPreparer

func (client WorkspaceCollectionsClient) CheckNameAvailabilityPreparer(location string, body CheckNameRequest) (*http.Request, error)

CheckNameAvailabilityPreparer prepares the CheckNameAvailability request.

func (WorkspaceCollectionsClient) CheckNameAvailabilityResponder

func (client WorkspaceCollectionsClient) CheckNameAvailabilityResponder(resp *http.Response) (result CheckNameResponse, err error)

CheckNameAvailabilityResponder handles the response to the CheckNameAvailability request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) CheckNameAvailabilitySender

func (client WorkspaceCollectionsClient) CheckNameAvailabilitySender(req *http.Request) (*http.Response, error)

CheckNameAvailabilitySender sends the CheckNameAvailability request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) Create

func (client WorkspaceCollectionsClient) Create(resourceGroupName string, workspaceCollectionName string, body CreateWorkspaceCollectionRequest) (result WorkspaceCollection, err error)

Create creates a new Power BI Workspace Collection with the specified properties. A Power BI Workspace Collection contains one or more workspaces, and can be used to provision keys that provide API access to those workspaces.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name body is create workspace collection request

func (WorkspaceCollectionsClient) CreatePreparer

func (client WorkspaceCollectionsClient) CreatePreparer(resourceGroupName string, workspaceCollectionName string, body CreateWorkspaceCollectionRequest) (*http.Request, error)

CreatePreparer prepares the Create request.

func (WorkspaceCollectionsClient) CreateResponder

func (client WorkspaceCollectionsClient) CreateResponder(resp *http.Response) (result WorkspaceCollection, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) CreateSender

func (client WorkspaceCollectionsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) Delete

func (client WorkspaceCollectionsClient) Delete(resourceGroupName string, workspaceCollectionName string, cancel <-chan struct{}) (<-chan autorest.Response, <-chan error)

Delete delete a Power BI Workspace Collection. This method may poll for completion. Polling can be canceled by passing the cancel channel argument. The channel will be used to cancel polling and any outstanding HTTP requests.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name

func (WorkspaceCollectionsClient) DeletePreparer

func (client WorkspaceCollectionsClient) DeletePreparer(resourceGroupName string, workspaceCollectionName string, cancel <-chan struct{}) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (WorkspaceCollectionsClient) DeleteResponder

func (client WorkspaceCollectionsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) DeleteSender

func (client WorkspaceCollectionsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) GetAccessKeys

func (client WorkspaceCollectionsClient) GetAccessKeys(resourceGroupName string, workspaceCollectionName string) (result WorkspaceCollectionAccessKeys, err error)

GetAccessKeys retrieves the primary and secondary access keys for the specified Power BI Workspace Collection.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name

func (WorkspaceCollectionsClient) GetAccessKeysPreparer

func (client WorkspaceCollectionsClient) GetAccessKeysPreparer(resourceGroupName string, workspaceCollectionName string) (*http.Request, error)

GetAccessKeysPreparer prepares the GetAccessKeys request.

func (WorkspaceCollectionsClient) GetAccessKeysResponder

func (client WorkspaceCollectionsClient) GetAccessKeysResponder(resp *http.Response) (result WorkspaceCollectionAccessKeys, err error)

GetAccessKeysResponder handles the response to the GetAccessKeys request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) GetAccessKeysSender

func (client WorkspaceCollectionsClient) GetAccessKeysSender(req *http.Request) (*http.Response, error)

GetAccessKeysSender sends the GetAccessKeys request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) GetByName

func (client WorkspaceCollectionsClient) GetByName(resourceGroupName string, workspaceCollectionName string) (result WorkspaceCollection, err error)

GetByName retrieves an existing Power BI Workspace Collection.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name

func (WorkspaceCollectionsClient) GetByNamePreparer

func (client WorkspaceCollectionsClient) GetByNamePreparer(resourceGroupName string, workspaceCollectionName string) (*http.Request, error)

GetByNamePreparer prepares the GetByName request.

func (WorkspaceCollectionsClient) GetByNameResponder

func (client WorkspaceCollectionsClient) GetByNameResponder(resp *http.Response) (result WorkspaceCollection, err error)

GetByNameResponder handles the response to the GetByName request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) GetByNameSender

func (client WorkspaceCollectionsClient) GetByNameSender(req *http.Request) (*http.Response, error)

GetByNameSender sends the GetByName request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) ListByResourceGroup

func (client WorkspaceCollectionsClient) ListByResourceGroup(resourceGroupName string) (result WorkspaceCollectionList, err error)

ListByResourceGroup retrieves all existing Power BI workspace collections in the specified resource group.

resourceGroupName is azure resource group

func (WorkspaceCollectionsClient) ListByResourceGroupPreparer

func (client WorkspaceCollectionsClient) ListByResourceGroupPreparer(resourceGroupName string) (*http.Request, error)

ListByResourceGroupPreparer prepares the ListByResourceGroup request.

func (WorkspaceCollectionsClient) ListByResourceGroupResponder

func (client WorkspaceCollectionsClient) ListByResourceGroupResponder(resp *http.Response) (result WorkspaceCollectionList, err error)

ListByResourceGroupResponder handles the response to the ListByResourceGroup request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) ListByResourceGroupSender

func (client WorkspaceCollectionsClient) ListByResourceGroupSender(req *http.Request) (*http.Response, error)

ListByResourceGroupSender sends the ListByResourceGroup request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) ListBySubscription

func (client WorkspaceCollectionsClient) ListBySubscription() (result WorkspaceCollectionList, err error)

ListBySubscription retrieves all existing Power BI workspace collections in the specified subscription.

func (WorkspaceCollectionsClient) ListBySubscriptionPreparer

func (client WorkspaceCollectionsClient) ListBySubscriptionPreparer() (*http.Request, error)

ListBySubscriptionPreparer prepares the ListBySubscription request.

func (WorkspaceCollectionsClient) ListBySubscriptionResponder

func (client WorkspaceCollectionsClient) ListBySubscriptionResponder(resp *http.Response) (result WorkspaceCollectionList, err error)

ListBySubscriptionResponder handles the response to the ListBySubscription request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) ListBySubscriptionSender

func (client WorkspaceCollectionsClient) ListBySubscriptionSender(req *http.Request) (*http.Response, error)

ListBySubscriptionSender sends the ListBySubscription request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) Migrate

func (client WorkspaceCollectionsClient) Migrate(resourceGroupName string, body MigrateWorkspaceCollectionRequest) (result autorest.Response, err error)

Migrate migrates an existing Power BI Workspace Collection to a different resource group and/or subscription.

resourceGroupName is azure resource group body is workspace migration request

func (WorkspaceCollectionsClient) MigratePreparer

func (client WorkspaceCollectionsClient) MigratePreparer(resourceGroupName string, body MigrateWorkspaceCollectionRequest) (*http.Request, error)

MigratePreparer prepares the Migrate request.

func (WorkspaceCollectionsClient) MigrateResponder

func (client WorkspaceCollectionsClient) MigrateResponder(resp *http.Response) (result autorest.Response, err error)

MigrateResponder handles the response to the Migrate request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) MigrateSender

func (client WorkspaceCollectionsClient) MigrateSender(req *http.Request) (*http.Response, error)

MigrateSender sends the Migrate request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) RegenerateKey

func (client WorkspaceCollectionsClient) RegenerateKey(resourceGroupName string, workspaceCollectionName string, body WorkspaceCollectionAccessKey) (result WorkspaceCollectionAccessKeys, err error)

RegenerateKey regenerates the primary or secondary access key for the specified Power BI Workspace Collection.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name body is access key to regenerate

func (WorkspaceCollectionsClient) RegenerateKeyPreparer

func (client WorkspaceCollectionsClient) RegenerateKeyPreparer(resourceGroupName string, workspaceCollectionName string, body WorkspaceCollectionAccessKey) (*http.Request, error)

RegenerateKeyPreparer prepares the RegenerateKey request.

func (WorkspaceCollectionsClient) RegenerateKeyResponder

func (client WorkspaceCollectionsClient) RegenerateKeyResponder(resp *http.Response) (result WorkspaceCollectionAccessKeys, err error)

RegenerateKeyResponder handles the response to the RegenerateKey request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) RegenerateKeySender

func (client WorkspaceCollectionsClient) RegenerateKeySender(req *http.Request) (*http.Response, error)

RegenerateKeySender sends the RegenerateKey request. The method will close the http.Response Body if it receives an error.

func (WorkspaceCollectionsClient) Update

func (client WorkspaceCollectionsClient) Update(resourceGroupName string, workspaceCollectionName string, body UpdateWorkspaceCollectionRequest) (result WorkspaceCollection, err error)

Update update an existing Power BI Workspace Collection with the specified properties.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name body is update workspace collection request

func (WorkspaceCollectionsClient) UpdatePreparer

func (client WorkspaceCollectionsClient) UpdatePreparer(resourceGroupName string, workspaceCollectionName string, body UpdateWorkspaceCollectionRequest) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (WorkspaceCollectionsClient) UpdateResponder

func (client WorkspaceCollectionsClient) UpdateResponder(resp *http.Response) (result WorkspaceCollection, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (WorkspaceCollectionsClient) UpdateSender

func (client WorkspaceCollectionsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type WorkspaceList

type WorkspaceList struct {
	autorest.Response `json:"-"`
	Value             *[]Workspace `json:"value,omitempty"`
}

WorkspaceList is

type WorkspacesClient

type WorkspacesClient struct {
	ManagementClient
}

WorkspacesClient is the client to manage your Power BI Embedded workspace collections and retrieve workspaces.

func NewWorkspacesClient

func NewWorkspacesClient(subscriptionID string) WorkspacesClient

NewWorkspacesClient creates an instance of the WorkspacesClient client.

func NewWorkspacesClientWithBaseURI

func NewWorkspacesClientWithBaseURI(baseURI string, subscriptionID string) WorkspacesClient

NewWorkspacesClientWithBaseURI creates an instance of the WorkspacesClient client.

func (WorkspacesClient) List

func (client WorkspacesClient) List(resourceGroupName string, workspaceCollectionName string) (result WorkspaceList, err error)

List retrieves all existing Power BI workspaces in the specified workspace collection.

resourceGroupName is azure resource group workspaceCollectionName is power BI Embedded Workspace Collection name

func (WorkspacesClient) ListPreparer

func (client WorkspacesClient) ListPreparer(resourceGroupName string, workspaceCollectionName string) (*http.Request, error)

ListPreparer prepares the List request.

func (WorkspacesClient) ListResponder

func (client WorkspacesClient) ListResponder(resp *http.Response) (result WorkspaceList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (WorkspacesClient) ListSender

func (client WorkspacesClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL