clusterprincipalassignments

package
v0.20241209.1115630 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2024-04-13/clusterprincipalassignments Documentation

The clusterprincipalassignments SDK allows for interaction with Azure Resource Manager kusto (API Version 2024-04-13).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2024-04-13/clusterprincipalassignments"

Client Initialization

client := clusterprincipalassignments.NewClusterPrincipalAssignmentsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ClusterPrincipalAssignmentsClient.CheckNameAvailability

ctx := context.TODO()
id := commonids.NewKustoClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName")

payload := clusterprincipalassignments.ClusterPrincipalAssignmentCheckNameRequest{
	// ...
}


read, err := client.CheckNameAvailability(ctx, id, payload)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ClusterPrincipalAssignmentsClient.CreateOrUpdate

ctx := context.TODO()
id := clusterprincipalassignments.NewPrincipalAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "principalAssignmentName")

payload := clusterprincipalassignments.ClusterPrincipalAssignment{
	// ...
}


if err := client.CreateOrUpdateThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: ClusterPrincipalAssignmentsClient.Delete

ctx := context.TODO()
id := clusterprincipalassignments.NewPrincipalAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "principalAssignmentName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: ClusterPrincipalAssignmentsClient.Get

ctx := context.TODO()
id := clusterprincipalassignments.NewPrincipalAssignmentID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName", "principalAssignmentName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: ClusterPrincipalAssignmentsClient.List

ctx := context.TODO()
id := commonids.NewKustoClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterName")

read, err := client.List(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForClusterPrincipalRole 

func PossibleValuesForClusterPrincipalRole() []string

func PossibleValuesForPrincipalAssignmentType 

func PossibleValuesForPrincipalAssignmentType() []string

func PossibleValuesForPrincipalType 

func PossibleValuesForPrincipalType() []string

func PossibleValuesForProvisioningState 

func PossibleValuesForProvisioningState() []string

func PossibleValuesForReason 

func PossibleValuesForReason() []string

func ValidatePrincipalAssignmentID 

func ValidatePrincipalAssignmentID(input interface{}, key string) (warnings []string, errors []error)

ValidatePrincipalAssignmentID checks that 'input' can be parsed as a Principal Assignment ID

Types

type CheckNameAvailabilityOperationResponse 

type CheckNameAvailabilityOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *CheckNameResult
}

type CheckNameResult 

type CheckNameResult struct {
	Message       *string `json:"message,omitempty"`
	Name          *string `json:"name,omitempty"`
	NameAvailable *bool   `json:"nameAvailable,omitempty"`
	Reason        *Reason `json:"reason,omitempty"`
}

type ClusterPrincipalAssignment 

type ClusterPrincipalAssignment struct {
	Id         *string                     `json:"id,omitempty"`
	Name       *string                     `json:"name,omitempty"`
	Properties *ClusterPrincipalProperties `json:"properties,omitempty"`
	Type       *string                     `json:"type,omitempty"`
}

type ClusterPrincipalAssignmentCheckNameRequest 

type ClusterPrincipalAssignmentCheckNameRequest struct {
	Name string                  `json:"name"`
	Type PrincipalAssignmentType `json:"type"`
}

type ClusterPrincipalAssignmentListResult 

type ClusterPrincipalAssignmentListResult struct {
	Value *[]ClusterPrincipalAssignment `json:"value,omitempty"`
}

type ClusterPrincipalAssignmentsClient 

type ClusterPrincipalAssignmentsClient struct {
	Client *resourcemanager.Client
}

func NewClusterPrincipalAssignmentsClientWithBaseURI 

func NewClusterPrincipalAssignmentsClientWithBaseURI(sdkApi sdkEnv.Api) (*ClusterPrincipalAssignmentsClient, error)

func (ClusterPrincipalAssignmentsClient) CheckNameAvailability 

func (c ClusterPrincipalAssignmentsClient) CheckNameAvailability(ctx context.Context, id commonids.KustoClusterId, input ClusterPrincipalAssignmentCheckNameRequest) (result CheckNameAvailabilityOperationResponse, err error)

CheckNameAvailability ...

func (ClusterPrincipalAssignmentsClient) CreateOrUpdate 

func (c ClusterPrincipalAssignmentsClient) CreateOrUpdate(ctx context.Context, id PrincipalAssignmentId, input ClusterPrincipalAssignment) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ClusterPrincipalAssignmentsClient) CreateOrUpdateThenPoll 

func (c ClusterPrincipalAssignmentsClient) CreateOrUpdateThenPoll(ctx context.Context, id PrincipalAssignmentId, input ClusterPrincipalAssignment) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ClusterPrincipalAssignmentsClient) Delete 

func (c ClusterPrincipalAssignmentsClient) Delete(ctx context.Context, id PrincipalAssignmentId) (result DeleteOperationResponse, err error)

Delete ...

func (ClusterPrincipalAssignmentsClient) DeleteThenPoll 

func (c ClusterPrincipalAssignmentsClient) DeleteThenPoll(ctx context.Context, id PrincipalAssignmentId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ClusterPrincipalAssignmentsClient) Get 

func (c ClusterPrincipalAssignmentsClient) Get(ctx context.Context, id PrincipalAssignmentId) (result GetOperationResponse, err error)

Get ...

func (ClusterPrincipalAssignmentsClient) List 

func (c ClusterPrincipalAssignmentsClient) List(ctx context.Context, id commonids.KustoClusterId) (result ListOperationResponse, err error)

List ...

type ClusterPrincipalProperties 

type ClusterPrincipalProperties struct {
	AadObjectId       *string              `json:"aadObjectId,omitempty"`
	PrincipalId       string               `json:"principalId"`
	PrincipalName     *string              `json:"principalName,omitempty"`
	PrincipalType     PrincipalType        `json:"principalType"`
	ProvisioningState *ProvisioningState   `json:"provisioningState,omitempty"`
	Role              ClusterPrincipalRole `json:"role"`
	TenantId          *string              `json:"tenantId,omitempty"`
	TenantName        *string              `json:"tenantName,omitempty"`
}

type ClusterPrincipalRole 

type ClusterPrincipalRole string
const (
	ClusterPrincipalRoleAllDatabasesAdmin   ClusterPrincipalRole = "AllDatabasesAdmin"
	ClusterPrincipalRoleAllDatabasesMonitor ClusterPrincipalRole = "AllDatabasesMonitor"
	ClusterPrincipalRoleAllDatabasesViewer  ClusterPrincipalRole = "AllDatabasesViewer"
)

func (*ClusterPrincipalRole) UnmarshalJSON 

func (s *ClusterPrincipalRole) UnmarshalJSON(bytes []byte) error

type CreateOrUpdateOperationResponse 

type CreateOrUpdateOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterPrincipalAssignment
}

type DeleteOperationResponse 

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterPrincipalAssignment
}

type ListOperationResponse 

type ListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ClusterPrincipalAssignmentListResult
}

type PrincipalAssignmentId 

type PrincipalAssignmentId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ClusterName             string
	PrincipalAssignmentName string
}

PrincipalAssignmentId is a struct representing the Resource ID for a Principal Assignment

func NewPrincipalAssignmentID 

func NewPrincipalAssignmentID(subscriptionId string, resourceGroupName string, clusterName string, principalAssignmentName string) PrincipalAssignmentId

NewPrincipalAssignmentID returns a new PrincipalAssignmentId struct

func ParsePrincipalAssignmentID 

func ParsePrincipalAssignmentID(input string) (*PrincipalAssignmentId, error)

ParsePrincipalAssignmentID parses 'input' into a PrincipalAssignmentId

func ParsePrincipalAssignmentIDInsensitively 

func ParsePrincipalAssignmentIDInsensitively(input string) (*PrincipalAssignmentId, error)

ParsePrincipalAssignmentIDInsensitively parses 'input' case-insensitively into a PrincipalAssignmentId note: this method should only be used for API response data and not user input

func (*PrincipalAssignmentId) FromParseResult 

func (id *PrincipalAssignmentId) FromParseResult(input resourceids.ParseResult) error

func (PrincipalAssignmentId) ID 

func (id PrincipalAssignmentId) ID() string

ID returns the formatted Principal Assignment ID

func (PrincipalAssignmentId) Segments 

func (id PrincipalAssignmentId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Principal Assignment ID

func (PrincipalAssignmentId) String 

func (id PrincipalAssignmentId) String() string

String returns a human-readable description of this Principal Assignment ID

type PrincipalAssignmentType 

type PrincipalAssignmentType string
const (
	PrincipalAssignmentTypeMicrosoftPointKustoClustersPrincipalAssignments PrincipalAssignmentType = "Microsoft.Kusto/clusters/principalAssignments"
)

func (*PrincipalAssignmentType) UnmarshalJSON 

func (s *PrincipalAssignmentType) UnmarshalJSON(bytes []byte) error

type PrincipalType 

type PrincipalType string
const (
	PrincipalTypeApp   PrincipalType = "App"
	PrincipalTypeGroup PrincipalType = "Group"
	PrincipalTypeUser  PrincipalType = "User"
)

func (*PrincipalType) UnmarshalJSON 

func (s *PrincipalType) UnmarshalJSON(bytes []byte) error

type ProvisioningState 

type ProvisioningState string
const (
	ProvisioningStateCanceled  ProvisioningState = "Canceled"
	ProvisioningStateCreating  ProvisioningState = "Creating"
	ProvisioningStateDeleting  ProvisioningState = "Deleting"
	ProvisioningStateFailed    ProvisioningState = "Failed"
	ProvisioningStateMoving    ProvisioningState = "Moving"
	ProvisioningStateRunning   ProvisioningState = "Running"
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
)

func (*ProvisioningState) UnmarshalJSON 

func (s *ProvisioningState) UnmarshalJSON(bytes []byte) error

type Reason 

type Reason string
const (
	ReasonAlreadyExists Reason = "AlreadyExists"
	ReasonInvalid       Reason = "Invalid"
)

func (*Reason) UnmarshalJSON 

func (s *Reason) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

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