armpowerbiprivatelinks

package module
v2.1.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: 14 Imported by: 1

README

PkgGoDev

The armpowerbiprivatelinks module provides operations for working with Azure Power BI Private Links.

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 Private Links module:

go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/powerbiprivatelinks/armpowerbiprivatelinks

Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Power BI Private Links. 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 Private Links 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 := armpowerbiprivatelinks.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 := armpowerbiprivatelinks.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.NewPowerBIResourcesClient()

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 Private Links 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

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType 

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. 

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ActionsRequired 

type ActionsRequired string

ActionsRequired - ActionsRequired 

const (
	ActionsRequiredNone     ActionsRequired = "None"
	ActionsRequiredRecreate ActionsRequired = "Recreate"
)

func PossibleActionsRequiredValues 

func PossibleActionsRequiredValues() []ActionsRequired

PossibleActionsRequiredValues returns the possible values for the ActionsRequired const type.

type AsyncOperationDetail 

type AsyncOperationDetail struct {
	// The operation end time.
	EndTime *string

	// The error.
	Error *ErrorDetail

	// The operation id.
	ID *string

	// The operation name.
	Name *string

	// The operation start time.
	StartTime *string

	// The operation status.
	Status *string
}

AsyncOperationDetail

func (AsyncOperationDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AsyncOperationDetail.

func (*AsyncOperationDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AsyncOperationDetail.

type ClientFactory 

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 

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 - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewPowerBIResourcesClient 

func (c *ClientFactory) NewPowerBIResourcesClient() *PowerBIResourcesClient

NewPowerBIResourcesClient creates a new instance of PowerBIResourcesClient.

func (*ClientFactory) NewPrivateEndpointConnectionsClient 

func (c *ClientFactory) NewPrivateEndpointConnectionsClient() *PrivateEndpointConnectionsClient

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient.

func (*ClientFactory) NewPrivateLinkResourcesClient 

func (c *ClientFactory) NewPrivateLinkResourcesClient() *PrivateLinkResourcesClient

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient.

func (*ClientFactory) NewPrivateLinkServiceResourceOperationResultsClient 

func (c *ClientFactory) NewPrivateLinkServiceResourceOperationResultsClient() *PrivateLinkServiceResourceOperationResultsClient

NewPrivateLinkServiceResourceOperationResultsClient creates a new instance of PrivateLinkServiceResourceOperationResultsClient.

func (*ClientFactory) NewPrivateLinkServicesClient 

func (c *ClientFactory) NewPrivateLinkServicesClient() *PrivateLinkServicesClient

NewPrivateLinkServicesClient creates a new instance of PrivateLinkServicesClient.

func (*ClientFactory) NewPrivateLinkServicesForPowerBIClient 

func (c *ClientFactory) NewPrivateLinkServicesForPowerBIClient() *PrivateLinkServicesForPowerBIClient

NewPrivateLinkServicesForPowerBIClient creates a new instance of PrivateLinkServicesForPowerBIClient.

type ConnectionState 

type ConnectionState struct {
	// Actions required (if any).
	ActionsRequired *string

	// Description of the connection state.
	Description *string

	// Status of the connection.
	Status *PersistedConnectionStatus
}

ConnectionState information.

func (ConnectionState) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ConnectionState.

func (*ConnectionState) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionState.

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type GroupConnectivityInformation 

type GroupConnectivityInformation struct {
	// Specifies the customer visible FQDNs of the group connectivity information.
	CustomerVisibleFqdns []*string

	// Specifies the group id of the group connectivity information.
	GroupID *string

	// Specifies the internal FQDN of the group connectivity information.
	InternalFqdn *string

	// Specifies the member name of the group connectivity information.
	MemberName *string

	// Specifies the ARM region of the group connectivity information.
	PrivateLinkServiceArmRegion *string
}

GroupConnectivityInformation

func (GroupConnectivityInformation) MarshalJSON 

func (g GroupConnectivityInformation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GroupConnectivityInformation.

func (*GroupConnectivityInformation) UnmarshalJSON 

func (g *GroupConnectivityInformation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GroupConnectivityInformation.

type Operation 

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane
	// operations.
	IsDataAction *bool

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
	// "Microsoft.Compute/virtualMachines/capture/action"
	Name *string

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
	// value is "user,system"
	Origin *Origin
}

Operation - Details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
	// Machine", "Restart Virtual Machine".
	Operation *string

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
	// Compute".
	Provider *string

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
	// Schedule Collections".
	Resource *string
}

OperationDisplay - Localized display information for this particular operation.

func (OperationDisplay) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation
}

OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationsClient 

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

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

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

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - Lists all of the available Power BI RP operations.

Generated from API version 2020-06-01

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/Operations_List.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewOperationsClient().NewListPager(nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.OperationListResult = armpowerbiprivatelinks.OperationListResult{
	// 	Value: []*armpowerbiprivatelinks.Operation{
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/read"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Gets all resources for the tenant private link service"),
	// 				Operation: to.Ptr("Gets all resources"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/operationResults/operationId/read"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Gets operation result of Private Link Service Resources for Power BI."),
	// 				Operation: to.Ptr("Get Operation Result"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/read"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Gets resources for the tenant private link service by name"),
	// 				Operation: to.Ptr("Gets resource by name"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/write"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Creates or updates resource for the tenant private link service"),
	// 				Operation: to.Ptr("Creates or updates private link service"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/delete"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Deletes resource for the tenant private link service"),
	// 				Operation: to.Ptr("Deletes private link service"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateLinkResources/read"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Gets private link resources in a Azure resource"),
	// 				Operation: to.Ptr("Gets private link resources by name"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/read"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Gets private endpoint connection proxy for the tenant"),
	// 				Operation: to.Ptr("Gets private endpoint connection proxy"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/write"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Creates or updates private endpoint connection proxy for the tenant"),
	// 				Operation: to.Ptr("Creates or updates private endpoint connection proxy"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/delete"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Deletes private endpoint connection proxy for the tenant"),
	// 				Operation: to.Ptr("Deletes private endpoint connection proxy"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnectionProxies/privateEndpointName.privateEndpointGuid/validate/action"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Validates a private endpoint connection proxy before create or update"),
	// 				Operation: to.Ptr("Validates a private endpoint connection proxy"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/privateEndpointName.privateEndpointGuid/read"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Gets private endpoint connection for the tenant"),
	// 				Operation: to.Ptr("Gets private endpoint connection"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/privateEndpointName.privateEndpointGuid/write"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Creates or updates private endpoint connection for the tenant"),
	// 				Operation: to.Ptr("Creates or updates private endpoint connection"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 		},
	// 		{
	// 			Name: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/privateEndpointName.privateEndpointGuid/delete"),
	// 			Display: &armpowerbiprivatelinks.OperationDisplay{
	// 				Description: to.Ptr("Deletes private endpoint connection for the tenant"),
	// 				Operation: to.Ptr("Deletes private endpoint connection"),
	// 				Provider: to.Ptr("Microsoft Power BI"),
	// 				Resource: to.Ptr("Private link service resources"),
	// 			},
	// 	}},
	// }
}

Output:

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type Origin 

type Origin string

Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" 

const (
	OriginSystem     Origin = "system"
	OriginUser       Origin = "user"
	OriginUserSystem Origin = "user,system"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

type PersistedConnectionStatus 

type PersistedConnectionStatus string

PersistedConnectionStatus - Status of the connection. 

const (
	PersistedConnectionStatusApproved     PersistedConnectionStatus = "Approved"
	PersistedConnectionStatusDisconnected PersistedConnectionStatus = "Disconnected"
	PersistedConnectionStatusPending      PersistedConnectionStatus = "Pending"
	PersistedConnectionStatusRejected     PersistedConnectionStatus = "Rejected"
)

func PossiblePersistedConnectionStatusValues 

func PossiblePersistedConnectionStatusValues() []PersistedConnectionStatus

PossiblePersistedConnectionStatusValues returns the possible values for the PersistedConnectionStatus const type.

type PowerBIResourcesClient 

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

PowerBIResourcesClient contains the methods for the PowerBIResources group. Don't use this type directly, use NewPowerBIResourcesClient() instead.

func NewPowerBIResourcesClient 

func NewPowerBIResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PowerBIResourcesClient, error)

NewPowerBIResourcesClient creates a new instance of PowerBIResourcesClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PowerBIResourcesClient) Create 

func (client *PowerBIResourcesClient) Create(ctx context.Context, resourceGroupName string, azureResourceName string, body TenantResource, options *PowerBIResourcesClientCreateOptions) (PowerBIResourcesClientCreateResponse, error)

Create - Creates or updates a Private Link Service Resource for Power BI. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • body - Tenant resource to be created or updated.
  • options - PowerBIResourcesClientCreateOptions contains the optional parameters for the PowerBIResourcesClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Create.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPowerBIResourcesClient().Create(ctx, "resourceGroup", "azureResourceName", armpowerbiprivatelinks.TenantResource{
	Location: to.Ptr("global"),
	Properties: &armpowerbiprivatelinks.TenantProperties{
		TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
	},
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, &armpowerbiprivatelinks.PowerBIResourcesClientCreateOptions{ClientTenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f")})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TenantResource = armpowerbiprivatelinks.TenantResource{
// 	Name: to.Ptr("myPrivateLinkServiceResource"),
// 	Location: to.Ptr("global"),
// 	Properties: &armpowerbiprivatelinks.TenantProperties{
// 		TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// }

Output:

func (*PowerBIResourcesClient) Delete 

func (client *PowerBIResourcesClient) Delete(ctx context.Context, resourceGroupName string, azureResourceName string, options *PowerBIResourcesClientDeleteOptions) (PowerBIResourcesClientDeleteResponse, error)

Delete - Deletes a Private Link Service Resource for Power BI. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • options - PowerBIResourcesClientDeleteOptions contains the optional parameters for the PowerBIResourcesClient.Delete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
_, err = clientFactory.NewPowerBIResourcesClient().Delete(ctx, "resourceGroup", "azureResourceName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}

Output:

func (*PowerBIResourcesClient) ListByResourceName 

func (client *PowerBIResourcesClient) ListByResourceName(ctx context.Context, resourceGroupName string, azureResourceName string, options *PowerBIResourcesClientListByResourceNameOptions) (PowerBIResourcesClientListByResourceNameResponse, error)

ListByResourceName - Gets all the private link resources for the given Azure resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • options - PowerBIResourcesClientListByResourceNameOptions contains the optional parameters for the PowerBIResourcesClient.ListByResourceName method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_ListByResourceName.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPowerBIResourcesClient().ListByResourceName(ctx, "resourceGroup", "azureResourceName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TenantResourceArray = []*armpowerbiprivatelinks.TenantResource{
// 	{
// 		Name: to.Ptr("conection 1"),
// 		Location: to.Ptr("west us"),
// 		Properties: &armpowerbiprivatelinks.TenantProperties{
// 			PrivateEndpointConnections: []*armpowerbiprivatelinks.PrivateEndpointConnection{
// 				{
// 					Name: to.Ptr("myPrivateEndpointConnection"),
// 					Type: to.Ptr("string"),
// 					ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointConnection.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
// 					Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
// 						PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
// 							ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"),
// 						},
// 						PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
// 							Description: to.Ptr("My private endpoint connection"),
// 							ActionsRequired: to.Ptr("None"),
// 							Status: to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatusPending),
// 						},
// 					},
// 			}},
// 			TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
// 		},
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("value1"),
// 			"tag2": to.Ptr("value2"),
// 		},
// }}

Output:

func (*PowerBIResourcesClient) Update 

func (client *PowerBIResourcesClient) Update(ctx context.Context, resourceGroupName string, azureResourceName string, body TenantResource, options *PowerBIResourcesClientUpdateOptions) (PowerBIResourcesClientUpdateResponse, error)

Update - Creates or updates a Private Link Service Resource for Power BI. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • body - Tenant resource to be created or updated.
  • options - PowerBIResourcesClientUpdateOptions contains the optional parameters for the PowerBIResourcesClient.Update method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PowerBIResources_Update.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPowerBIResourcesClient().Update(ctx, "resourceGroup", "azureResourceName", armpowerbiprivatelinks.TenantResource{
	Location: to.Ptr("global"),
	Properties: &armpowerbiprivatelinks.TenantProperties{
		TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
	},
	Tags: map[string]*string{
		"tag1": to.Ptr("value1"),
		"tag2": to.Ptr("value2"),
	},
}, &armpowerbiprivatelinks.PowerBIResourcesClientUpdateOptions{ClientTenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f")})
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TenantResource = armpowerbiprivatelinks.TenantResource{
// 	Name: to.Ptr("myPrivateLinkServiceResource"),
// 	Location: to.Ptr("global"),
// 	Properties: &armpowerbiprivatelinks.TenantProperties{
// 		TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
// 	},
// 	Tags: map[string]*string{
// 		"tag1": to.Ptr("value1"),
// 		"tag2": to.Ptr("value2"),
// 	},
// }

Output:

type PowerBIResourcesClientCreateOptions 

type PowerBIResourcesClientCreateOptions struct {
	// The client tenant id in header. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
	ClientTenantID *string
}

PowerBIResourcesClientCreateOptions contains the optional parameters for the PowerBIResourcesClient.Create method.

type PowerBIResourcesClientCreateResponse 

type PowerBIResourcesClientCreateResponse struct {
	// TenantResource
	TenantResource
}

PowerBIResourcesClientCreateResponse contains the response from method PowerBIResourcesClient.Create.

type PowerBIResourcesClientDeleteOptions 

type PowerBIResourcesClientDeleteOptions struct {
}

PowerBIResourcesClientDeleteOptions contains the optional parameters for the PowerBIResourcesClient.Delete method.

type PowerBIResourcesClientDeleteResponse 

type PowerBIResourcesClientDeleteResponse struct {
}

PowerBIResourcesClientDeleteResponse contains the response from method PowerBIResourcesClient.Delete.

type PowerBIResourcesClientListByResourceNameOptions 

type PowerBIResourcesClientListByResourceNameOptions struct {
}

PowerBIResourcesClientListByResourceNameOptions contains the optional parameters for the PowerBIResourcesClient.ListByResourceName method.

type PowerBIResourcesClientListByResourceNameResponse 

type PowerBIResourcesClientListByResourceNameResponse struct {
	// Array of TenantResource
	TenantResourceArray []*TenantResource
}

PowerBIResourcesClientListByResourceNameResponse contains the response from method PowerBIResourcesClient.ListByResourceName.

type PowerBIResourcesClientUpdateOptions 

type PowerBIResourcesClientUpdateOptions struct {
	// The client tenant id in header. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
	ClientTenantID *string
}

PowerBIResourcesClientUpdateOptions contains the optional parameters for the PowerBIResourcesClient.Update method.

type PowerBIResourcesClientUpdateResponse 

type PowerBIResourcesClientUpdateResponse struct {
	// TenantResource
	TenantResource
}

PowerBIResourcesClientUpdateResponse contains the response from method PowerBIResourcesClient.Update.

type PrivateEndpoint 

type PrivateEndpoint struct {
	// Specifies the id of private endpoint.
	ID *string
}

PrivateEndpoint

func (PrivateEndpoint) MarshalJSON 

func (p PrivateEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpoint.

func (*PrivateEndpoint) UnmarshalJSON 

func (p *PrivateEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpoint.

type PrivateEndpointConnection 

type PrivateEndpointConnection struct {
	// Specifies the properties of the private endpoint connection.
	Properties *PrivateEndpointConnectionProperties

	// READ-ONLY; Specifies the id of the resource.
	ID *string

	// READ-ONLY; Specifies the name of the resource.
	Name *string

	// READ-ONLY; The system meta data relating to this resource.
	SystemData *SystemData

	// READ-ONLY; Specifies the type of the resource.
	Type *string
}

PrivateEndpointConnection

func (PrivateEndpointConnection) MarshalJSON 

func (p PrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnection.

func (*PrivateEndpointConnection) UnmarshalJSON 

func (p *PrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnection.

type PrivateEndpointConnectionListResult 

type PrivateEndpointConnectionListResult struct {
	// Specifies the name of the private endpoint connection.
	Value []*PrivateEndpointConnection

	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string
}

PrivateEndpointConnectionListResult - List of private endpoint connections.

func (PrivateEndpointConnectionListResult) MarshalJSON 

func (p PrivateEndpointConnectionListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionListResult.

func (*PrivateEndpointConnectionListResult) UnmarshalJSON 

func (p *PrivateEndpointConnectionListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionListResult.

type PrivateEndpointConnectionProperties 

type PrivateEndpointConnectionProperties struct {
	// Specifies the private endpoint.
	PrivateEndpoint *PrivateEndpoint

	// Specifies the connection state.
	PrivateLinkServiceConnectionState *ConnectionState

	// Provisioning state of the Private Endpoint Connection.
	ProvisioningState *ResourceProvisioningState
}

PrivateEndpointConnectionProperties

func (PrivateEndpointConnectionProperties) MarshalJSON 

func (p PrivateEndpointConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateEndpointConnectionProperties.

func (*PrivateEndpointConnectionProperties) UnmarshalJSON 

func (p *PrivateEndpointConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateEndpointConnectionProperties.

type PrivateEndpointConnectionsClient 

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

PrivateEndpointConnectionsClient contains the methods for the PrivateEndpointConnections group. Don't use this type directly, use NewPrivateEndpointConnectionsClient() instead.

func NewPrivateEndpointConnectionsClient 

func NewPrivateEndpointConnectionsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateEndpointConnectionsClient, error)

NewPrivateEndpointConnectionsClient creates a new instance of PrivateEndpointConnectionsClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateEndpointConnectionsClient) BeginDelete 

func (client *PrivateEndpointConnectionsClient) BeginDelete(ctx context.Context, resourceGroupName string, azureResourceName string, privateEndpointName string, options *PrivateEndpointConnectionsClientBeginDeleteOptions) (*runtime.Poller[PrivateEndpointConnectionsClientDeleteResponse], error)

BeginDelete - Deletes a private endpoint connection for Power BI by private endpoint name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • privateEndpointName - The name of the private endpoint.
  • options - PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateEndpointConnectionsClient().BeginDelete(ctx, "resourceGroup", "azureResourceName", "myPrivateEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
_, err = poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}

Output:

func (*PrivateEndpointConnectionsClient) Create 

func (client *PrivateEndpointConnectionsClient) Create(ctx context.Context, resourceGroupName string, azureResourceName string, privateEndpointName string, privateEndpointConnection PrivateEndpointConnection, options *PrivateEndpointConnectionsClientCreateOptions) (PrivateEndpointConnectionsClientCreateResponse, error)

Create - Updates the status of Private Endpoint Connection object. Used to approve or reject a connection. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • privateEndpointName - The name of the private endpoint.
  • privateEndpointConnection - Private endpoint connection object to update.
  • options - PrivateEndpointConnectionsClientCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Create method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Create.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Create(ctx, "resourceGroup", "azureResourceName", "myPrivateEndpointName", armpowerbiprivatelinks.PrivateEndpointConnection{
	Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
		PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
			ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName"),
		},
		PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
			Description:     to.Ptr(""),
			ActionsRequired: to.Ptr("None"),
			Status:          to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatus("Approved ")),
		},
	},
}, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armpowerbiprivatelinks.PrivateEndpointConnection{
// 	Name: to.Ptr("myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
// 	Type: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
// 	Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName"),
// 		},
// 		PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
// 			Description: to.Ptr(""),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatus("Approved ")),
// 		},
// 	},
// }

Output:

func (*PrivateEndpointConnectionsClient) Get 

func (client *PrivateEndpointConnectionsClient) Get(ctx context.Context, resourceGroupName string, azureResourceName string, privateEndpointName string, options *PrivateEndpointConnectionsClientGetOptions) (PrivateEndpointConnectionsClientGetResponse, error)

Get - Get a specific private endpoint connection for Power BI by private endpoint name. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • privateEndpointName - The name of the private endpoint.
  • options - PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateEndpointConnectionsClient().Get(ctx, "resourceGroup", "azureResourceName", "myPrivateEndpointName", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateEndpointConnection = armpowerbiprivatelinks.PrivateEndpointConnection{
// 	Name: to.Ptr("myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
// 	Type: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections"),
// 	ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
// 	Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
// 		PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
// 			ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpointName"),
// 		},
// 		PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
// 			Description: to.Ptr("please approve"),
// 			ActionsRequired: to.Ptr("None"),
// 			Status: to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatusPending),
// 		},
// 	},
// }

Output:

func (*PrivateEndpointConnectionsClient) NewListByResourcePager 

func (client *PrivateEndpointConnectionsClient) NewListByResourcePager(resourceGroupName string, azureResourceName string, options *PrivateEndpointConnectionsClientListByResourceOptions) *runtime.Pager[PrivateEndpointConnectionsClientListByResourceResponse]

NewListByResourcePager - Gets private endpoint connection for Power BI.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group within the user's subscription.
  • azureResourceName - The name of the powerbi resource.
  • options - PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateEndpointConnectionsClient().NewListByResourcePager("resourceGroup", "azureResourceName", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateEndpointConnectionListResult = armpowerbiprivatelinks.PrivateEndpointConnectionListResult{
	// 	Value: []*armpowerbiprivatelinks.PrivateEndpointConnection{
	// 		{
	// 			Name: to.Ptr("myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
	// 			Type: to.Ptr("Microsoft.PowerBI/privateLinkServicesForPowerBI/privateEndpointConnections"),
	// 			ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName.58ffb8de-89ad-41eb-9f8f-de0a7db9d721"),
	// 			Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
	// 				PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
	// 					ID: to.Ptr("/subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateEndpointConnections/myPrivateEndpointName"),
	// 				},
	// 				PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
	// 					Description: to.Ptr("Test"),
	// 					ActionsRequired: to.Ptr("None"),
	// 					Status: to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatusPending),
	// 				},
	// 			},
	// 	}},
	// }
}

Output:

type PrivateEndpointConnectionsClientBeginDeleteOptions 

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

PrivateEndpointConnectionsClientBeginDeleteOptions contains the optional parameters for the PrivateEndpointConnectionsClient.BeginDelete method.

type PrivateEndpointConnectionsClientCreateOptions 

type PrivateEndpointConnectionsClientCreateOptions struct {
}

PrivateEndpointConnectionsClientCreateOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Create method.

type PrivateEndpointConnectionsClientCreateResponse 

type PrivateEndpointConnectionsClientCreateResponse struct {
	// PrivateEndpointConnection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientCreateResponse contains the response from method PrivateEndpointConnectionsClient.Create.

type PrivateEndpointConnectionsClientDeleteResponse 

type PrivateEndpointConnectionsClientDeleteResponse struct {
}

PrivateEndpointConnectionsClientDeleteResponse contains the response from method PrivateEndpointConnectionsClient.BeginDelete.

type PrivateEndpointConnectionsClientGetOptions 

type PrivateEndpointConnectionsClientGetOptions struct {
}

PrivateEndpointConnectionsClientGetOptions contains the optional parameters for the PrivateEndpointConnectionsClient.Get method.

type PrivateEndpointConnectionsClientGetResponse 

type PrivateEndpointConnectionsClientGetResponse struct {
	// PrivateEndpointConnection
	PrivateEndpointConnection
}

PrivateEndpointConnectionsClientGetResponse contains the response from method PrivateEndpointConnectionsClient.Get.

type PrivateEndpointConnectionsClientListByResourceOptions 

type PrivateEndpointConnectionsClientListByResourceOptions struct {
}

PrivateEndpointConnectionsClientListByResourceOptions contains the optional parameters for the PrivateEndpointConnectionsClient.NewListByResourcePager method.

type PrivateEndpointConnectionsClientListByResourceResponse 

type PrivateEndpointConnectionsClientListByResourceResponse struct {
	// List of private endpoint connections.
	PrivateEndpointConnectionListResult
}

PrivateEndpointConnectionsClientListByResourceResponse contains the response from method PrivateEndpointConnectionsClient.NewListByResourcePager.

type PrivateLinkConnectionDetail 

type PrivateLinkConnectionDetail struct {
	// Specifies the group id of the connection detail.
	GroupID *string

	// Specifies the type of the connection detail.
	ID *string

	// Specifies the link id of the connection detail.
	LinkIdentifier *string

	// Specifies the member name of the connection detail.
	MemberName *string

	// Specifies the private ip address of the connection detail.
	PrivateIPAddress *string
}

PrivateLinkConnectionDetail

func (PrivateLinkConnectionDetail) MarshalJSON 

func (p PrivateLinkConnectionDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkConnectionDetail.

func (*PrivateLinkConnectionDetail) UnmarshalJSON 

func (p *PrivateLinkConnectionDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkConnectionDetail.

type PrivateLinkResource 

type PrivateLinkResource struct {
	// Fully qualified identifier of the resource.
	ID *string

	// Name of the resource.
	Name *string

	// Resource properties.
	Properties *PrivateLinkResourceProperties

	// Type of the resource.
	Type *string
}

PrivateLinkResource - A private link resource

func (PrivateLinkResource) MarshalJSON 

func (p PrivateLinkResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResource.

func (*PrivateLinkResource) UnmarshalJSON 

func (p *PrivateLinkResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResource.

type PrivateLinkResourceProperties 

type PrivateLinkResourceProperties struct {
	// The private link resource Private link DNS zone name.
	RequiredZoneNames []*string

	// READ-ONLY; The private link resource group id.
	GroupID *string

	// READ-ONLY; The private link resource required member names.
	RequiredMembers []*string
}

PrivateLinkResourceProperties - Properties of a private link resource.

func (PrivateLinkResourceProperties) MarshalJSON 

func (p PrivateLinkResourceProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourceProperties.

func (*PrivateLinkResourceProperties) UnmarshalJSON 

func (p *PrivateLinkResourceProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourceProperties.

type PrivateLinkResourcesClient 

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

PrivateLinkResourcesClient contains the methods for the PrivateLinkResources group. Don't use this type directly, use NewPrivateLinkResourcesClient() instead.

func NewPrivateLinkResourcesClient 

func NewPrivateLinkResourcesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkResourcesClient, error)

NewPrivateLinkResourcesClient creates a new instance of PrivateLinkResourcesClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkResourcesClient) Get 

func (client *PrivateLinkResourcesClient) Get(ctx context.Context, resourceGroupName string, azureResourceName string, privateLinkResourceName string, options *PrivateLinkResourcesClientGetOptions) (PrivateLinkResourcesClientGetResponse, error)

Get - Get properties of a private link resource. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • privateLinkResourceName - The name of private link resource.
  • options - PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkResourcesClient().Get(ctx, "resourceGroup", "azureResourceName", "tenant", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.PrivateLinkResource = armpowerbiprivatelinks.PrivateLinkResource{
// 	Name: to.Ptr("tenant"),
// 	Type: to.Ptr("Microsoft.PowerBI/{resourceType}/privateLinkResources"),
// 	ID: to.Ptr("subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateLinkResources/tenant"),
// 	Properties: &armpowerbiprivatelinks.PrivateLinkResourceProperties{
// 		GroupID: to.Ptr("tenant"),
// 		RequiredMembers: []*string{
// 			to.Ptr("tenant"),
// 			to.Ptr("capacity:3df897a4f10b49e9bddb0e9cf062adba")},
// 			RequiredZoneNames: []*string{
// 				to.Ptr("privatelink.powerbi.com")},
// 			},
// 		}

Output:

func (*PrivateLinkResourcesClient) NewListByResourcePager 

func (client *PrivateLinkResourcesClient) NewListByResourcePager(resourceGroupName string, azureResourceName string, options *PrivateLinkResourcesClientListByResourceOptions) *runtime.Pager[PrivateLinkResourcesClientListByResourceResponse]

NewListByResourcePager - List private link resources under a specific Power BI resource.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • azureResourceName - The name of the Azure resource.
  • options - PrivateLinkResourcesClientListByResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListByResourcePager method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
pager := clientFactory.NewPrivateLinkResourcesClient().NewListByResourcePager("resourceGroup", "azureResourceName", nil)
for pager.More() {
	page, err := pager.NextPage(ctx)
	if err != nil {
		log.Fatalf("failed to advance page: %v", err)
	}
	for _, v := range page.Value {
		// You could use page here. We use blank identifier for just demo purposes.
		_ = v
	}
	// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// page.PrivateLinkResourcesListResult = armpowerbiprivatelinks.PrivateLinkResourcesListResult{
	// 	Value: []*armpowerbiprivatelinks.PrivateLinkResource{
	// 		{
	// 			Name: to.Ptr("tenant"),
	// 			Type: to.Ptr("Microsoft.PowerBI/{resourceType}/privateLinkResources"),
	// 			ID: to.Ptr("subscriptions/a0020869-4d28-422a-89f4-c2413130d73c/resourceGroups/resourceGroup/providers/Microsoft.PowerBI/privateLinkServicesForPowerBI/azureResourceName/privateLinkResources/tenant"),
	// 			Properties: &armpowerbiprivatelinks.PrivateLinkResourceProperties{
	// 				GroupID: to.Ptr("tenant"),
	// 				RequiredMembers: []*string{
	// 					to.Ptr("tenant"),
	// 					to.Ptr("capacity:3df897a4f10b49e9bddb0e9cf062adba")},
	// 					RequiredZoneNames: []*string{
	// 						to.Ptr("privatelink.powerbi.com")},
	// 					},
	// 			}},
	// 		}
}

Output:

type PrivateLinkResourcesClientGetOptions 

type PrivateLinkResourcesClientGetOptions struct {
}

PrivateLinkResourcesClientGetOptions contains the optional parameters for the PrivateLinkResourcesClient.Get method.

type PrivateLinkResourcesClientGetResponse 

type PrivateLinkResourcesClientGetResponse struct {
	// A private link resource
	PrivateLinkResource
}

PrivateLinkResourcesClientGetResponse contains the response from method PrivateLinkResourcesClient.Get.

type PrivateLinkResourcesClientListByResourceOptions 

type PrivateLinkResourcesClientListByResourceOptions struct {
}

PrivateLinkResourcesClientListByResourceOptions contains the optional parameters for the PrivateLinkResourcesClient.NewListByResourcePager method.

type PrivateLinkResourcesClientListByResourceResponse 

type PrivateLinkResourcesClientListByResourceResponse struct {
	// Specifies list of the private link resource.
	PrivateLinkResourcesListResult
}

PrivateLinkResourcesClientListByResourceResponse contains the response from method PrivateLinkResourcesClient.NewListByResourcePager.

type PrivateLinkResourcesListResult 

type PrivateLinkResourcesListResult struct {
	// A collection of private endpoint connection resources.
	Value []*PrivateLinkResource

	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string
}

PrivateLinkResourcesListResult - Specifies list of the private link resource.

func (PrivateLinkResourcesListResult) MarshalJSON 

func (p PrivateLinkResourcesListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkResourcesListResult.

func (*PrivateLinkResourcesListResult) UnmarshalJSON 

func (p *PrivateLinkResourcesListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkResourcesListResult.

type PrivateLinkServiceConnection 

type PrivateLinkServiceConnection struct {
	// Specifies the group ids of the private link service connection.
	GroupIDs []*string

	// Specifies the name of the private link service connection.
	Name *string

	// Specifies the request message of the private link service connection.
	RequestMessage *string
}

PrivateLinkServiceConnection

func (PrivateLinkServiceConnection) MarshalJSON 

func (p PrivateLinkServiceConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceConnection.

func (*PrivateLinkServiceConnection) UnmarshalJSON 

func (p *PrivateLinkServiceConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceConnection.

type PrivateLinkServiceProxy 

type PrivateLinkServiceProxy struct {
	// Specifies the group connectivity information of the private link service proxy.
	GroupConnectivityInformation []*GroupConnectivityInformation

	// Specifies the id of the private link service proxy.
	ID *string

	// Specifies the private endpoint connection of the private link service proxy.
	RemotePrivateEndpointConnection *RemotePrivateEndpointConnection

	// Specifies the connection state of the private link service proxy.
	RemotePrivateLinkServiceConnectionState *ConnectionState
}

PrivateLinkServiceProxy

func (PrivateLinkServiceProxy) MarshalJSON 

func (p PrivateLinkServiceProxy) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PrivateLinkServiceProxy.

func (*PrivateLinkServiceProxy) UnmarshalJSON 

func (p *PrivateLinkServiceProxy) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PrivateLinkServiceProxy.

type PrivateLinkServiceResourceOperationResultsClient 

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

PrivateLinkServiceResourceOperationResultsClient contains the methods for the PrivateLinkServiceResourceOperationResults group. Don't use this type directly, use NewPrivateLinkServiceResourceOperationResultsClient() instead.

func NewPrivateLinkServiceResourceOperationResultsClient 

func NewPrivateLinkServiceResourceOperationResultsClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkServiceResourceOperationResultsClient, error)

NewPrivateLinkServiceResourceOperationResultsClient creates a new instance of PrivateLinkServiceResourceOperationResultsClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkServiceResourceOperationResultsClient) BeginGet 

func (client *PrivateLinkServiceResourceOperationResultsClient) BeginGet(ctx context.Context, operationID string, options *PrivateLinkServiceResourceOperationResultsClientBeginGetOptions) (*runtime.Poller[PrivateLinkServiceResourceOperationResultsClientGetResponse], error)

BeginGet - Gets operation result of Private Link Service Resources for Power BI. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • operationID - The id of Azure async operation.
  • options - PrivateLinkServiceResourceOperationResultsClientBeginGetOptions contains the optional parameters for the PrivateLinkServiceResourceOperationResultsClient.BeginGet method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServiceResourceOperationResults_Get.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
poller, err := clientFactory.NewPrivateLinkServiceResourceOperationResultsClient().BeginGet(ctx, "9a062a88-e463-4697-bef2-fe039df73a02", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
res, err := poller.PollUntilDone(ctx, nil)
if err != nil {
	log.Fatalf("failed to pull the result: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.AsyncOperationDetail = armpowerbiprivatelinks.AsyncOperationDetail{
// 	Name: to.Ptr("9a062a88-e463-4697-bef2-fe039df73a02"),
// 	StartTime: to.Ptr("2017-01-06T18:58:24.7596323+00:00"),
// 	Status: to.Ptr("InProgress"),
// }

Output:

type PrivateLinkServiceResourceOperationResultsClientBeginGetOptions 

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

PrivateLinkServiceResourceOperationResultsClientBeginGetOptions contains the optional parameters for the PrivateLinkServiceResourceOperationResultsClient.BeginGet method.

type PrivateLinkServiceResourceOperationResultsClientGetResponse 

type PrivateLinkServiceResourceOperationResultsClientGetResponse struct {
	// AsyncOperationDetail
	AsyncOperationDetail
}

PrivateLinkServiceResourceOperationResultsClientGetResponse contains the response from method PrivateLinkServiceResourceOperationResultsClient.BeginGet.

type PrivateLinkServicesClient 

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

PrivateLinkServicesClient contains the methods for the PrivateLinkServices group. Don't use this type directly, use NewPrivateLinkServicesClient() instead.

func NewPrivateLinkServicesClient 

func NewPrivateLinkServicesClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkServicesClient, error)

NewPrivateLinkServicesClient creates a new instance of PrivateLinkServicesClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkServicesClient) ListByResourceGroup 

func (client *PrivateLinkServicesClient) ListByResourceGroup(ctx context.Context, resourceGroupName string, options *PrivateLinkServicesClientListByResourceGroupOptions) (PrivateLinkServicesClientListByResourceGroupResponse, error)

ListByResourceGroup - Gets all the private link resources for the given resource group. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • resourceGroupName - The name of the resource group.
  • options - PrivateLinkServicesClientListByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.ListByResourceGroup method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListByResourceGroup.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkServicesClient().ListByResourceGroup(ctx, "resourceGroup", nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TenantResourceArray = []*armpowerbiprivatelinks.TenantResource{
// 	{
// 		Name: to.Ptr("conection 1"),
// 		Location: to.Ptr("west us"),
// 		Properties: &armpowerbiprivatelinks.TenantProperties{
// 			PrivateEndpointConnections: []*armpowerbiprivatelinks.PrivateEndpointConnection{
// 				{
// 					Name: to.Ptr("myPrivateEndpointConnections"),
// 					Type: to.Ptr("string"),
// 					ID: to.Ptr("1001"),
// 					Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
// 						PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
// 							ID: to.Ptr("myPrivateEndpoint"),
// 						},
// 						PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
// 							Description: to.Ptr("My private endpoint connection"),
// 							ActionsRequired: to.Ptr("None"),
// 							Status: to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatusPending),
// 						},
// 					},
// 			}},
// 			TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
// 		},
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("value1"),
// 			"tag2": to.Ptr("value2"),
// 		},
// }}

Output:

type PrivateLinkServicesClientListByResourceGroupOptions 

type PrivateLinkServicesClientListByResourceGroupOptions struct {
}

PrivateLinkServicesClientListByResourceGroupOptions contains the optional parameters for the PrivateLinkServicesClient.ListByResourceGroup method.

type PrivateLinkServicesClientListByResourceGroupResponse 

type PrivateLinkServicesClientListByResourceGroupResponse struct {
	// Array of TenantResource
	TenantResourceArray []*TenantResource
}

PrivateLinkServicesClientListByResourceGroupResponse contains the response from method PrivateLinkServicesClient.ListByResourceGroup.

type PrivateLinkServicesForPowerBIClient 

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

PrivateLinkServicesForPowerBIClient contains the methods for the PrivateLinkServicesForPowerBI group. Don't use this type directly, use NewPrivateLinkServicesForPowerBIClient() instead.

func NewPrivateLinkServicesForPowerBIClient 

func NewPrivateLinkServicesForPowerBIClient(subscriptionID string, credential azcore.TokenCredential, options *arm.ClientOptions) (*PrivateLinkServicesForPowerBIClient, error)

NewPrivateLinkServicesForPowerBIClient creates a new instance of PrivateLinkServicesForPowerBIClient with the specified values.

  • subscriptionID - The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*PrivateLinkServicesForPowerBIClient) ListBySubscriptionID 

func (client *PrivateLinkServicesForPowerBIClient) ListBySubscriptionID(ctx context.Context, options *PrivateLinkServicesForPowerBIClientListBySubscriptionIDOptions) (PrivateLinkServicesForPowerBIClientListBySubscriptionIDResponse, error)

ListBySubscriptionID - Gets all the private link resources for the given subscription id. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2020-06-01

  • options - PrivateLinkServicesForPowerBIClientListBySubscriptionIDOptions contains the optional parameters for the PrivateLinkServicesForPowerBIClient.ListBySubscriptionID method.
Example

Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/f790e624d0d080b89d962a3bd19c65bc6a6b2f5e/specification/powerbiprivatelinks/resource-manager/Microsoft.PowerBI/stable/2020-06-01/examples/PrivateLinkServices_ListBySubscriptionId.json 

cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
	log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armpowerbiprivatelinks.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
	log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewPrivateLinkServicesForPowerBIClient().ListBySubscriptionID(ctx, nil)
if err != nil {
	log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.TenantResourceArray = []*armpowerbiprivatelinks.TenantResource{
// 	{
// 		Name: to.Ptr("conection 1"),
// 		Location: to.Ptr("west us"),
// 		Properties: &armpowerbiprivatelinks.TenantProperties{
// 			PrivateEndpointConnections: []*armpowerbiprivatelinks.PrivateEndpointConnection{
// 				{
// 					Name: to.Ptr("myPrivateEndpointConnections"),
// 					Type: to.Ptr("string"),
// 					ID: to.Ptr("1001"),
// 					Properties: &armpowerbiprivatelinks.PrivateEndpointConnectionProperties{
// 						PrivateEndpoint: &armpowerbiprivatelinks.PrivateEndpoint{
// 							ID: to.Ptr("myPrivateEndpoint"),
// 						},
// 						PrivateLinkServiceConnectionState: &armpowerbiprivatelinks.ConnectionState{
// 							Description: to.Ptr("My private endpoint connection"),
// 							ActionsRequired: to.Ptr("None"),
// 							Status: to.Ptr(armpowerbiprivatelinks.PersistedConnectionStatusPending),
// 						},
// 					},
// 			}},
// 			TenantID: to.Ptr("ac2bc297-8a3e-46f3-972d-87c2b4ae6e2f"),
// 		},
// 		Tags: map[string]*string{
// 			"tag1": to.Ptr("value1"),
// 			"tag2": to.Ptr("value2"),
// 		},
// }}

Output:

type PrivateLinkServicesForPowerBIClientListBySubscriptionIDOptions 

type PrivateLinkServicesForPowerBIClientListBySubscriptionIDOptions struct {
}

PrivateLinkServicesForPowerBIClientListBySubscriptionIDOptions contains the optional parameters for the PrivateLinkServicesForPowerBIClient.ListBySubscriptionID method.

type PrivateLinkServicesForPowerBIClientListBySubscriptionIDResponse 

type PrivateLinkServicesForPowerBIClientListBySubscriptionIDResponse struct {
	// Array of TenantResource
	TenantResourceArray []*TenantResource
}

PrivateLinkServicesForPowerBIClientListBySubscriptionIDResponse contains the response from method PrivateLinkServicesForPowerBIClient.ListBySubscriptionID.

type RemotePrivateEndpointConnection 

type RemotePrivateEndpointConnection struct {
	// Specifies the id of private endpoint connection.
	ID *string
}

RemotePrivateEndpointConnection

func (RemotePrivateEndpointConnection) MarshalJSON 

func (r RemotePrivateEndpointConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RemotePrivateEndpointConnection.

func (*RemotePrivateEndpointConnection) UnmarshalJSON 

func (r *RemotePrivateEndpointConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RemotePrivateEndpointConnection.

type ResourceProvisioningState 

type ResourceProvisioningState string

ResourceProvisioningState - Provisioning state of the Private Endpoint Connection. 

const (
	ResourceProvisioningStateCanceled  ResourceProvisioningState = "Canceled"
	ResourceProvisioningStateCreating  ResourceProvisioningState = "Creating"
	ResourceProvisioningStateDeleting  ResourceProvisioningState = "Deleting"
	ResourceProvisioningStateFailed    ResourceProvisioningState = "Failed"
	ResourceProvisioningStateSucceeded ResourceProvisioningState = "Succeeded"
	ResourceProvisioningStateUpdating  ResourceProvisioningState = "Updating"
)

func PossibleResourceProvisioningStateValues 

func PossibleResourceProvisioningStateValues() []ResourceProvisioningState

PossibleResourceProvisioningStateValues returns the possible values for the ResourceProvisioningState const type.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

func (s SystemData) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TenantProperties 

type TenantProperties struct {
	// Specifies the private endpoint connections of the resource.
	PrivateEndpointConnections []*PrivateEndpointConnection

	// Specifies the tenant id of the resource.
	TenantID *string
}

TenantProperties

func (TenantProperties) MarshalJSON 

func (t TenantProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantProperties.

func (*TenantProperties) UnmarshalJSON 

func (t *TenantProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TenantProperties.

type TenantResource 

type TenantResource struct {
	// Specifies the location of the resource.
	Location *string

	// Specifies the properties of the resource.
	Properties *TenantProperties

	// Specifies the tags of the resource.
	Tags map[string]*string

	// READ-ONLY; Specifies the resource identifier of the resource.
	ID *string

	// READ-ONLY; Specifies the name of the resource.
	Name *string

	// READ-ONLY; The system metadata relating to this resource.
	SystemData *SystemData

	// READ-ONLY; Specifies the type of the resource.
	Type *string
}

TenantResource

func (TenantResource) MarshalJSON 

func (t TenantResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TenantResource.

func (*TenantResource) UnmarshalJSON 

func (t *TenantResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TenantResource.

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.