armpowerbiembedded

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Nov 24, 2023 License: MIT Imports: 12 Imported by: 0

README

Azure Power BI Embedded Module for Go

PkgGoDev

The armpowerbiembedded module provides operations for working with Azure Power BI Embedded.

Source code

Getting started

Prerequisites

  • an Azure subscription
  • Go 1.18 or above (You could download and install the latest version of Go from here. It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this doc.)

Install the package

This project uses Go modules for versioning and dependency management.

Install the Azure Power BI Embedded module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/powerbiembedded/armpowerbiembedded

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Power BI Embedded. The azidentity module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.

cred, err := azidentity.NewDefaultAzureCredential(nil)

For more information on authentication, please see the documentation for azidentity at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity.

Client Factory

Azure Power BI Embedded module consists of one or more clients. We provide a client factory which could be used to create any client in this module.

clientFactory, err := armpowerbiembedded.NewClientFactory(<subscription ID>, cred, nil)

You can use ClientOptions in package github.com/Azure/azure-sdk-for-go/sdk/azcore/arm to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for azcore at pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore.

options := arm.ClientOptions {
    ClientOptions: azcore.ClientOptions {
        Cloud: cloud.AzureChina,
    },
}
clientFactory, err := armpowerbiembedded.NewClientFactory(<subscription ID>, cred, &options)

Clients

A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory.

client := clientFactory.NewWorkspacesClient()

Fakes

The fake package contains types used for constructing in-memory fake servers used in unit tests. This allows writing tests to cover various success/error conditions without the need for connecting to a live service.

Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes.

Provide Feedback

If you encounter bugs or have suggestions, please open an issue and assign the Power BI Embedded label.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessKeyName 

type AccessKeyName string

AccessKeyName - Key name 

const (
	AccessKeyNameKey1 AccessKeyName = "key1"
	AccessKeyNameKey2 AccessKeyName = "key2"
)

func PossibleAccessKeyNameValues 

func PossibleAccessKeyNameValues() []AccessKeyName

PossibleAccessKeyNameValues returns the possible values for the AccessKeyName const type.

type AzureSKU 

type AzureSKU struct {
	// REQUIRED; SKU name
	Name *AzureSKUName

	// REQUIRED; SKU tier
	Tier *AzureSKUTier
}

func (AzureSKU) MarshalJSON added in v1.1.0 

func (a AzureSKU) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureSKU.

func (*AzureSKU) UnmarshalJSON added in v1.1.0 

func (a *AzureSKU) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureSKU.

type AzureSKUName 

type AzureSKUName string

AzureSKUName - SKU name 

const (
	AzureSKUNameS1 AzureSKUName = "S1"
)

func PossibleAzureSKUNameValues 

func PossibleAzureSKUNameValues() []AzureSKUName

PossibleAzureSKUNameValues returns the possible values for the AzureSKUName const type.

type AzureSKUTier 

type AzureSKUTier string

AzureSKUTier - SKU tier 

const (
	AzureSKUTierStandard AzureSKUTier = "Standard"
)

func PossibleAzureSKUTierValues 

func PossibleAzureSKUTierValues() []AzureSKUTier

PossibleAzureSKUTierValues returns the possible values for the AzureSKUTier const type.

type CheckNameReason 

type CheckNameReason string

CheckNameReason - Reason why the workspace collection name cannot be used. 

const (
	CheckNameReasonInvalid     CheckNameReason = "Invalid"
	CheckNameReasonUnavailable CheckNameReason = "Unavailable"
)

func PossibleCheckNameReasonValues 

func PossibleCheckNameReasonValues() []CheckNameReason

PossibleCheckNameReasonValues returns the possible values for the CheckNameReason const type.

type CheckNameRequest 

type CheckNameRequest struct {
	// Workspace collection name
	Name *string

	// Resource type
	Type *string
}

func (CheckNameRequest) MarshalJSON added in v1.1.0 

func (c CheckNameRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameRequest.

func (*CheckNameRequest) UnmarshalJSON added in v1.1.0 

func (c *CheckNameRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameRequest.

type CheckNameResponse 

type CheckNameResponse struct {
	// Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated.
	Message *string

	// Specifies a Boolean value that indicates whether the specified Power BI Workspace Collection name is available to use.
	NameAvailable *bool

	// Reason why the workspace collection name cannot be used.
	Reason *CheckNameReason
}

func (CheckNameResponse) MarshalJSON added in v1.1.0 

func (c CheckNameResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CheckNameResponse.

func (*CheckNameResponse) UnmarshalJSON added in v1.1.0 

func (c *CheckNameResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CheckNameResponse.

type ClientFactory added in v1.1.0 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory added in v1.1.0 

func NewClientFactory(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • subscriptionID - Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewManagementClient added in v1.1.0 

func (c *ClientFactory) NewManagementClient() *ManagementClient

NewManagementClient creates a new instance of ManagementClient.

func (*ClientFactory) NewWorkspaceCollectionsClient added in v1.1.0 

func (c *ClientFactory) NewWorkspaceCollectionsClient() *WorkspaceCollectionsClient

NewWorkspaceCollectionsClient creates a new instance of WorkspaceCollectionsClient.

func (*ClientFactory) NewWorkspacesClient added in v1.1.0 

func (c *ClientFactory) NewWorkspacesClient() *WorkspacesClient

NewWorkspacesClient creates a new instance of WorkspacesClient.

type CreateWorkspaceCollectionRequest 

type CreateWorkspaceCollectionRequest struct {
	// Azure location
	Location *string
	SKU      *AzureSKU

	// Dictionary of
	Tags map[string]*string
}

func (CreateWorkspaceCollectionRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type CreateWorkspaceCollectionRequest.

func (*CreateWorkspaceCollectionRequest) UnmarshalJSON added in v1.1.0 

func (c *CreateWorkspaceCollectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CreateWorkspaceCollectionRequest.

type Display 

type Display struct {
	// 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

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

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

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

	// 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
}

func (Display) MarshalJSON added in v1.1.0 

func (d Display) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Display.

func (*Display) UnmarshalJSON added in v1.1.0 

func (d *Display) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Display.

type Error 

type Error struct {
	Code    *string
	Details []*ErrorDetail
	Message *string
	Target  *string
}

func (Error) MarshalJSON added in v0.2.0 

func (e Error) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Error.

func (*Error) UnmarshalJSON added in v1.1.0 

func (e *Error) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Error.

type ErrorDetail 

type ErrorDetail struct {
	Code    *string
	Message *string
	Target  *string
}

func (ErrorDetail) MarshalJSON added in v1.1.0 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON added in v1.1.0 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ManagementClient added in v0.2.0 

type ManagementClient struct {
	// contains filtered or unexported fields
}

ManagementClient contains the methods for the PowerBIEmbeddedManagementClient group. Don't use this type directly, use NewManagementClient() instead.

func NewManagementClient added in v0.2.0 

func NewManagementClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*ManagementClient, error)

NewManagementClient creates a new instance of ManagementClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ManagementClient) GetAvailableOperations added in v0.2.0 

func (client *ManagementClient) GetAvailableOperations(ctx context.Context, options *ManagementClientGetAvailableOperationsOptions) (ManagementClientGetAvailableOperationsResponse, error)

GetAvailableOperations - Indicates which operations can be performed by the Power BI Resource Provider. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • options - ManagementClientGetAvailableOperationsOptions contains the optional parameters for the ManagementClient.GetAvailableOperations method.

type ManagementClientGetAvailableOperationsOptions added in v0.2.0 

type ManagementClientGetAvailableOperationsOptions struct {
}

ManagementClientGetAvailableOperationsOptions contains the optional parameters for the ManagementClient.GetAvailableOperations method.

type ManagementClientGetAvailableOperationsResponse added in v0.2.0 

type ManagementClientGetAvailableOperationsResponse struct {
	OperationList
}

ManagementClientGetAvailableOperationsResponse contains the response from method ManagementClient.GetAvailableOperations.

type MigrateWorkspaceCollectionRequest 

type MigrateWorkspaceCollectionRequest struct {
	Resources []*string

	// Name of the resource group the Power BI workspace collections will be migrated to.
	TargetResourceGroup *string
}

func (MigrateWorkspaceCollectionRequest) MarshalJSON 

func (m MigrateWorkspaceCollectionRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MigrateWorkspaceCollectionRequest.

func (*MigrateWorkspaceCollectionRequest) UnmarshalJSON added in v1.1.0 

func (m *MigrateWorkspaceCollectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MigrateWorkspaceCollectionRequest.

type Operation 

type Operation struct {
	Display *Display

	// 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
}

func (Operation) MarshalJSON added in v1.1.0 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON added in v1.1.0 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationList 

type OperationList struct {
	Value []*Operation
}

func (OperationList) MarshalJSON 

func (o OperationList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationList.

func (*OperationList) UnmarshalJSON added in v1.1.0 

func (o *OperationList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationList.

type UpdateWorkspaceCollectionRequest 

type UpdateWorkspaceCollectionRequest struct {
	SKU *AzureSKU

	// Dictionary of
	Tags map[string]*string
}

func (UpdateWorkspaceCollectionRequest) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type UpdateWorkspaceCollectionRequest.

func (*UpdateWorkspaceCollectionRequest) UnmarshalJSON added in v1.1.0 

func (u *UpdateWorkspaceCollectionRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type UpdateWorkspaceCollectionRequest.

type Workspace 

type Workspace struct {
	// Workspace id
	ID *string

	// Workspace name
	Name *string

	// Property bag
	Properties any

	// Resource type
	Type *string
}

func (Workspace) MarshalJSON added in v1.1.0 

func (w Workspace) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Workspace.

func (*Workspace) UnmarshalJSON added in v1.1.0 

func (w *Workspace) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Workspace.

type WorkspaceCollection 

type WorkspaceCollection struct {
	// Resource id
	ID *string

	// Azure location
	Location *string

	// Workspace collection name
	Name *string

	// Properties
	Properties any
	SKU        *AzureSKU

	// Dictionary of
	Tags map[string]*string

	// Resource type
	Type *string
}

func (WorkspaceCollection) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type WorkspaceCollection.

func (*WorkspaceCollection) UnmarshalJSON added in v1.1.0 

func (w *WorkspaceCollection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceCollection.

type WorkspaceCollectionAccessKey 

type WorkspaceCollectionAccessKey struct {
	// Key name
	KeyName *AccessKeyName
}

func (WorkspaceCollectionAccessKey) MarshalJSON added in v1.1.0 

func (w WorkspaceCollectionAccessKey) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceCollectionAccessKey.

func (*WorkspaceCollectionAccessKey) UnmarshalJSON added in v1.1.0 

func (w *WorkspaceCollectionAccessKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceCollectionAccessKey.

type WorkspaceCollectionAccessKeys 

type WorkspaceCollectionAccessKeys struct {
	// Access key 1
	Key1 *string

	// Access key 2
	Key2 *string
}

func (WorkspaceCollectionAccessKeys) MarshalJSON added in v1.1.0 

func (w WorkspaceCollectionAccessKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceCollectionAccessKeys.

func (*WorkspaceCollectionAccessKeys) UnmarshalJSON added in v1.1.0 

func (w *WorkspaceCollectionAccessKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceCollectionAccessKeys.

type WorkspaceCollectionList 

type WorkspaceCollectionList struct {
	Value []*WorkspaceCollection
}

func (WorkspaceCollectionList) MarshalJSON 

func (w WorkspaceCollectionList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceCollectionList.

func (*WorkspaceCollectionList) UnmarshalJSON added in v1.1.0 

func (w *WorkspaceCollectionList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceCollectionList.

type WorkspaceCollectionsClient 

type WorkspaceCollectionsClient struct {
	// contains filtered or unexported fields
}

WorkspaceCollectionsClient contains the methods for the WorkspaceCollections group. Don't use this type directly, use NewWorkspaceCollectionsClient() instead.

func NewWorkspaceCollectionsClient 

func NewWorkspaceCollectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspaceCollectionsClient, error)

NewWorkspaceCollectionsClient creates a new instance of WorkspaceCollectionsClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspaceCollectionsClient) BeginDelete 

func (client *WorkspaceCollectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, workspaceCollectionName string, options *WorkspaceCollectionsClientBeginDeleteOptions) (*runtime.Poller[WorkspaceCollectionsClientDeleteResponse], error)

BeginDelete - Delete a Power BI Workspace Collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • options - WorkspaceCollectionsClientBeginDeleteOptions contains the optional parameters for the WorkspaceCollectionsClient.BeginDelete method.

func (*WorkspaceCollectionsClient) CheckNameAvailability 

func (client *WorkspaceCollectionsClient) CheckNameAvailability(ctx context.Context, location string, body CheckNameRequest, options *WorkspaceCollectionsClientCheckNameAvailabilityOptions) (WorkspaceCollectionsClientCheckNameAvailabilityResponse, error)

CheckNameAvailability - Verify the specified Power BI Workspace Collection name is valid and not already in use. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • location - Azure location
  • body - Check name availability request
  • options - WorkspaceCollectionsClientCheckNameAvailabilityOptions contains the optional parameters for the WorkspaceCollectionsClient.CheckNameAvailability method.

func (*WorkspaceCollectionsClient) Create 

func (client *WorkspaceCollectionsClient) Create(ctx context.Context, resourceGroupName string, workspaceCollectionName string, body CreateWorkspaceCollectionRequest, options *WorkspaceCollectionsClientCreateOptions) (WorkspaceCollectionsClientCreateResponse, 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. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • body - Create workspace collection request
  • options - WorkspaceCollectionsClientCreateOptions contains the optional parameters for the WorkspaceCollectionsClient.Create method.

func (*WorkspaceCollectionsClient) GetAccessKeys 

func (client *WorkspaceCollectionsClient) GetAccessKeys(ctx context.Context, resourceGroupName string, workspaceCollectionName string, options *WorkspaceCollectionsClientGetAccessKeysOptions) (WorkspaceCollectionsClientGetAccessKeysResponse, error)

GetAccessKeys - Retrieves the primary and secondary access keys for the specified Power BI Workspace Collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • options - WorkspaceCollectionsClientGetAccessKeysOptions contains the optional parameters for the WorkspaceCollectionsClient.GetAccessKeys method.

func (*WorkspaceCollectionsClient) GetByName 

func (client *WorkspaceCollectionsClient) GetByName(ctx context.Context, resourceGroupName string, workspaceCollectionName string, options *WorkspaceCollectionsClientGetByNameOptions) (WorkspaceCollectionsClientGetByNameResponse, error)

GetByName - Retrieves an existing Power BI Workspace Collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • options - WorkspaceCollectionsClientGetByNameOptions contains the optional parameters for the WorkspaceCollectionsClient.GetByName method.

func (*WorkspaceCollectionsClient) Migrate 

func (client *WorkspaceCollectionsClient) Migrate(ctx context.Context, resourceGroupName string, body MigrateWorkspaceCollectionRequest, options *WorkspaceCollectionsClientMigrateOptions) (WorkspaceCollectionsClientMigrateResponse, error)

Migrate - Migrates an existing Power BI Workspace Collection to a different resource group and/or subscription. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • body - Workspace migration request
  • options - WorkspaceCollectionsClientMigrateOptions contains the optional parameters for the WorkspaceCollectionsClient.Migrate method.

func (*WorkspaceCollectionsClient) NewListByResourceGroupPager added in v0.4.0 

func (client *WorkspaceCollectionsClient) NewListByResourceGroupPager(resourceGroupName string, options *WorkspaceCollectionsClientListByResourceGroupOptions) *runtime.Pager[WorkspaceCollectionsClientListByResourceGroupResponse]

NewListByResourceGroupPager - Retrieves all existing Power BI workspace collections in the specified resource group.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • options - WorkspaceCollectionsClientListByResourceGroupOptions contains the optional parameters for the WorkspaceCollectionsClient.NewListByResourceGroupPager method.

func (*WorkspaceCollectionsClient) NewListBySubscriptionPager added in v0.4.0 

func (client *WorkspaceCollectionsClient) NewListBySubscriptionPager(options *WorkspaceCollectionsClientListBySubscriptionOptions) *runtime.Pager[WorkspaceCollectionsClientListBySubscriptionResponse]

NewListBySubscriptionPager - Retrieves all existing Power BI workspace collections in the specified subscription.

Generated from API version 2016-01-29

  • options - WorkspaceCollectionsClientListBySubscriptionOptions contains the optional parameters for the WorkspaceCollectionsClient.NewListBySubscriptionPager method.

func (*WorkspaceCollectionsClient) RegenerateKey 

func (client *WorkspaceCollectionsClient) RegenerateKey(ctx context.Context, resourceGroupName string, workspaceCollectionName string, body WorkspaceCollectionAccessKey, options *WorkspaceCollectionsClientRegenerateKeyOptions) (WorkspaceCollectionsClientRegenerateKeyResponse, error)

RegenerateKey - Regenerates the primary or secondary access key for the specified Power BI Workspace Collection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • body - Access key to regenerate
  • options - WorkspaceCollectionsClientRegenerateKeyOptions contains the optional parameters for the WorkspaceCollectionsClient.RegenerateKey method.

func (*WorkspaceCollectionsClient) Update 

func (client *WorkspaceCollectionsClient) Update(ctx context.Context, resourceGroupName string, workspaceCollectionName string, body UpdateWorkspaceCollectionRequest, options *WorkspaceCollectionsClientUpdateOptions) (WorkspaceCollectionsClientUpdateResponse, error)

Update - Update an existing Power BI Workspace Collection with the specified properties. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • body - Update workspace collection request
  • options - WorkspaceCollectionsClientUpdateOptions contains the optional parameters for the WorkspaceCollectionsClient.Update method.

type WorkspaceCollectionsClientBeginDeleteOptions added in v0.2.0 

type WorkspaceCollectionsClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

WorkspaceCollectionsClientBeginDeleteOptions contains the optional parameters for the WorkspaceCollectionsClient.BeginDelete method.

type WorkspaceCollectionsClientCheckNameAvailabilityOptions added in v0.2.0 

type WorkspaceCollectionsClientCheckNameAvailabilityOptions struct {
}

WorkspaceCollectionsClientCheckNameAvailabilityOptions contains the optional parameters for the WorkspaceCollectionsClient.CheckNameAvailability method.

type WorkspaceCollectionsClientCheckNameAvailabilityResponse added in v0.2.0 

type WorkspaceCollectionsClientCheckNameAvailabilityResponse struct {
	CheckNameResponse
}

WorkspaceCollectionsClientCheckNameAvailabilityResponse contains the response from method WorkspaceCollectionsClient.CheckNameAvailability.

type WorkspaceCollectionsClientCreateOptions added in v0.2.0 

type WorkspaceCollectionsClientCreateOptions struct {
}

WorkspaceCollectionsClientCreateOptions contains the optional parameters for the WorkspaceCollectionsClient.Create method.

type WorkspaceCollectionsClientCreateResponse added in v0.2.0 

type WorkspaceCollectionsClientCreateResponse struct {
	WorkspaceCollection
}

WorkspaceCollectionsClientCreateResponse contains the response from method WorkspaceCollectionsClient.Create.

type WorkspaceCollectionsClientDeleteResponse added in v0.2.0 

type WorkspaceCollectionsClientDeleteResponse struct {
}

WorkspaceCollectionsClientDeleteResponse contains the response from method WorkspaceCollectionsClient.BeginDelete.

type WorkspaceCollectionsClientGetAccessKeysOptions added in v0.2.0 

type WorkspaceCollectionsClientGetAccessKeysOptions struct {
}

WorkspaceCollectionsClientGetAccessKeysOptions contains the optional parameters for the WorkspaceCollectionsClient.GetAccessKeys method.

type WorkspaceCollectionsClientGetAccessKeysResponse added in v0.2.0 

type WorkspaceCollectionsClientGetAccessKeysResponse struct {
	WorkspaceCollectionAccessKeys
}

WorkspaceCollectionsClientGetAccessKeysResponse contains the response from method WorkspaceCollectionsClient.GetAccessKeys.

type WorkspaceCollectionsClientGetByNameOptions added in v0.2.0 

type WorkspaceCollectionsClientGetByNameOptions struct {
}

WorkspaceCollectionsClientGetByNameOptions contains the optional parameters for the WorkspaceCollectionsClient.GetByName method.

type WorkspaceCollectionsClientGetByNameResponse added in v0.2.0 

type WorkspaceCollectionsClientGetByNameResponse struct {
	WorkspaceCollection
}

WorkspaceCollectionsClientGetByNameResponse contains the response from method WorkspaceCollectionsClient.GetByName.

type WorkspaceCollectionsClientListByResourceGroupOptions added in v0.2.0 

type WorkspaceCollectionsClientListByResourceGroupOptions struct {
}

WorkspaceCollectionsClientListByResourceGroupOptions contains the optional parameters for the WorkspaceCollectionsClient.NewListByResourceGroupPager method.

type WorkspaceCollectionsClientListByResourceGroupResponse added in v0.2.0 

type WorkspaceCollectionsClientListByResourceGroupResponse struct {
	WorkspaceCollectionList
}

WorkspaceCollectionsClientListByResourceGroupResponse contains the response from method WorkspaceCollectionsClient.NewListByResourceGroupPager.

type WorkspaceCollectionsClientListBySubscriptionOptions added in v0.2.0 

type WorkspaceCollectionsClientListBySubscriptionOptions struct {
}

WorkspaceCollectionsClientListBySubscriptionOptions contains the optional parameters for the WorkspaceCollectionsClient.NewListBySubscriptionPager method.

type WorkspaceCollectionsClientListBySubscriptionResponse added in v0.2.0 

type WorkspaceCollectionsClientListBySubscriptionResponse struct {
	WorkspaceCollectionList
}

WorkspaceCollectionsClientListBySubscriptionResponse contains the response from method WorkspaceCollectionsClient.NewListBySubscriptionPager.

type WorkspaceCollectionsClientMigrateOptions added in v0.2.0 

type WorkspaceCollectionsClientMigrateOptions struct {
}

WorkspaceCollectionsClientMigrateOptions contains the optional parameters for the WorkspaceCollectionsClient.Migrate method.

type WorkspaceCollectionsClientMigrateResponse added in v0.2.0 

type WorkspaceCollectionsClientMigrateResponse struct {
}

WorkspaceCollectionsClientMigrateResponse contains the response from method WorkspaceCollectionsClient.Migrate.

type WorkspaceCollectionsClientRegenerateKeyOptions added in v0.2.0 

type WorkspaceCollectionsClientRegenerateKeyOptions struct {
}

WorkspaceCollectionsClientRegenerateKeyOptions contains the optional parameters for the WorkspaceCollectionsClient.RegenerateKey method.

type WorkspaceCollectionsClientRegenerateKeyResponse added in v0.2.0 

type WorkspaceCollectionsClientRegenerateKeyResponse struct {
	WorkspaceCollectionAccessKeys
}

WorkspaceCollectionsClientRegenerateKeyResponse contains the response from method WorkspaceCollectionsClient.RegenerateKey.

type WorkspaceCollectionsClientUpdateOptions added in v0.2.0 

type WorkspaceCollectionsClientUpdateOptions struct {
}

WorkspaceCollectionsClientUpdateOptions contains the optional parameters for the WorkspaceCollectionsClient.Update method.

type WorkspaceCollectionsClientUpdateResponse added in v0.2.0 

type WorkspaceCollectionsClientUpdateResponse struct {
	WorkspaceCollection
}

WorkspaceCollectionsClientUpdateResponse contains the response from method WorkspaceCollectionsClient.Update.

type WorkspaceList 

type WorkspaceList struct {
	Value []*Workspace
}

func (WorkspaceList) MarshalJSON 

func (w WorkspaceList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type WorkspaceList.

func (*WorkspaceList) UnmarshalJSON added in v1.1.0 

func (w *WorkspaceList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type WorkspaceList.

type WorkspacesClient 

type WorkspacesClient struct {
	// contains filtered or unexported fields
}

WorkspacesClient contains the methods for the Workspaces group. Don't use this type directly, use NewWorkspacesClient() instead.

func NewWorkspacesClient 

func NewWorkspacesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*WorkspacesClient, error)

NewWorkspacesClient creates a new instance of WorkspacesClient with the specified values.

  • subscriptionID - Gets subscription credentials which uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*WorkspacesClient) NewListPager added in v0.4.0 

func (client *WorkspacesClient) NewListPager(resourceGroupName string, workspaceCollectionName string, options *WorkspacesClientListOptions) *runtime.Pager[WorkspacesClientListResponse]

NewListPager - Retrieves all existing Power BI workspaces in the specified workspace collection.

Generated from API version 2016-01-29

  • resourceGroupName - Azure resource group
  • workspaceCollectionName - Power BI Embedded Workspace Collection name
  • options - WorkspacesClientListOptions contains the optional parameters for the WorkspacesClient.NewListPager method.

type WorkspacesClientListOptions added in v0.2.0 

type WorkspacesClientListOptions struct {
}

WorkspacesClientListOptions contains the optional parameters for the WorkspacesClient.NewListPager method.

type WorkspacesClientListResponse added in v0.2.0 

type WorkspacesClientListResponse struct {
	WorkspaceList
}

WorkspacesClientListResponse contains the response from method WorkspacesClient.NewListPager.

Source Files

View all Source files

Directories

Path Synopsis

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.