powerbiembedded

package
v14.1.1+incompatible Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2018 License: Apache-2.0 Imports: 7 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 ...
	Key1 AccessKeyName = "key1"
	// Key2 ...
	Key2 AccessKeyName = "key2"
)

type AzureSku 

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

AzureSku ...

type BaseClient 

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

BaseClient is the base client for Powerbiembedded.

func New 

func New(subscriptionID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI 

func NewWithBaseURI(baseURI string, subscriptionID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client.

func (BaseClient) GetAvailableOperations 

func (client BaseClient) GetAvailableOperations(ctx context.Context) (result OperationList, err error)

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

func (BaseClient) GetAvailableOperationsPreparer 

func (client BaseClient) GetAvailableOperationsPreparer(ctx context.Context) (*http.Request, error)

GetAvailableOperationsPreparer prepares the GetAvailableOperations request.

func (BaseClient) GetAvailableOperationsResponder 

func (client BaseClient) 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 (BaseClient) GetAvailableOperationsSender 

func (client BaseClient) 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 CheckNameReason 

type CheckNameReason string

CheckNameReason enumerates the values for check name reason. 

const (
	// Invalid ...
	Invalid CheckNameReason = "Invalid"
	// Unavailable ...
	Unavailable CheckNameReason = "Unavailable"
)

type CheckNameRequest 

type CheckNameRequest struct {
	// Name - Workspace collection name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
}

CheckNameRequest ...

type CheckNameResponse 

type CheckNameResponse struct {
	autorest.Response `json:"-"`
	// NameAvailable - Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use.
	NameAvailable *bool `json:"nameAvailable,omitempty"`
	// Reason - Reason why the workspace collection name cannot be used. Possible values include: 'Unavailable', 'Invalid'
	Reason CheckNameReason `json:"reason,omitempty"`
	// Message - Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
	Message *string `json:"message,omitempty"`
}

CheckNameResponse ...

type CreateWorkspaceCollectionRequest 

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

CreateWorkspaceCollectionRequest ...

func (CreateWorkspaceCollectionRequest) MarshalJSON 

func (cwcr CreateWorkspaceCollectionRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CreateWorkspaceCollectionRequest.

type Display 

type Display struct {
	// Provider - The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with “Microsoft” for 1st party services.
	Provider *string `json:"provider,omitempty"`
	// Resource - The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section.
	Resource *string `json:"resource,omitempty"`
	// Operation - The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies.
	Operation *string `json:"operation,omitempty"`
	// Description - The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views.
	Description *string `json:"description,omitempty"`
	// Origin - The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system'
	Origin *string `json:"origin,omitempty"`
}

Display ...

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 ...

type ErrorDetail 

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

ErrorDetail ...

type MigrateWorkspaceCollectionRequest 

type MigrateWorkspaceCollectionRequest struct {
	// TargetResourceGroup - Name of the resource group the Power BI workspace collections will be migrated to.
	TargetResourceGroup *string   `json:"targetResourceGroup,omitempty"`
	Resources           *[]string `json:"resources,omitempty"`
}

MigrateWorkspaceCollectionRequest ...

type Operation 

type Operation struct {
	// Name - The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service.
	Name    *string  `json:"name,omitempty"`
	Display *Display `json:"display,omitempty"`
}

Operation ...

type OperationList 

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

OperationList ...

type UpdateWorkspaceCollectionRequest 

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

UpdateWorkspaceCollectionRequest ...

func (UpdateWorkspaceCollectionRequest) MarshalJSON 

func (uwcr UpdateWorkspaceCollectionRequest) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UpdateWorkspaceCollectionRequest.

type Workspace 

type Workspace struct {
	// ID - Workspace id
	ID *string `json:"id,omitempty"`
	// Name - Workspace name
	Name *string `json:"name,omitempty"`
	// Type - Resource type
	Type *string `json:"type,omitempty"`
	// Properties - Property bag
	Properties interface{} `json:"properties,omitempty"`
}

Workspace ...

type WorkspaceCollection 

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

WorkspaceCollection ...

func (WorkspaceCollection) MarshalJSON 

func (wc WorkspaceCollection) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for WorkspaceCollection.

type WorkspaceCollectionAccessKey 

type WorkspaceCollectionAccessKey struct {
	// KeyName - Key name. Possible values include: 'Key1', 'Key2'
	KeyName AccessKeyName `json:"keyName,omitempty"`
}

WorkspaceCollectionAccessKey ...

type WorkspaceCollectionAccessKeys 

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

WorkspaceCollectionAccessKeys ...

type WorkspaceCollectionList 

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

WorkspaceCollectionList ...

type WorkspaceCollectionsClient 

type WorkspaceCollectionsClient struct {
	BaseClient
}

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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, resourceGroupName string, workspaceCollectionName string) (result WorkspaceCollectionsDeleteFuture, err error)

Delete delete a Power BI Workspace Collection.

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

func (WorkspaceCollectionsClient) DeletePreparer 

func (client WorkspaceCollectionsClient) DeletePreparer(ctx context.Context, resourceGroupName string, workspaceCollectionName string) (*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) (future WorkspaceCollectionsDeleteFuture, err 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context) (result WorkspaceCollectionList, err error)

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

func (WorkspaceCollectionsClient) ListBySubscriptionPreparer 

func (client WorkspaceCollectionsClient) ListBySubscriptionPreparer(ctx context.Context) (*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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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(ctx context.Context, 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 WorkspaceCollectionsDeleteFuture 

type WorkspaceCollectionsDeleteFuture struct {
	azure.Future
	// contains filtered or unexported fields
}

WorkspaceCollectionsDeleteFuture an abstraction for monitoring and retrieving the results of a long-running operation.

func (WorkspaceCollectionsDeleteFuture) Result 

func (future WorkspaceCollectionsDeleteFuture) Result(client WorkspaceCollectionsClient) (ar autorest.Response, err error)

Result returns the result of the asynchronous operation. If the operation has not completed it will return an error.

type WorkspaceList 

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

WorkspaceList ...

type WorkspacesClient 

type WorkspacesClient struct {
	BaseClient
}

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(ctx context.Context, 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(ctx context.Context, 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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.