clusterprincipalassignments

package
v0.20230523.1113455 Latest Latest
Warning

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

Go to latest
Published: May 23, 2023 License: MPL-2.0 Imports: 8 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/kusto/2022-02-01/clusterprincipalassignments Documentation

The clusterprincipalassignments SDK allows for interaction with the Azure Resource Manager Service kusto (API Version 2022-02-01).

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-sdk/resource-manager/kusto/2022-02-01/clusterprincipalassignments"

Client Initialization

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

Example Usage: ClusterPrincipalAssignmentsClient.CheckNameAvailability

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

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", "clusterValue", "principalAssignmentValue")

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", "clusterValue", "principalAssignmentValue")

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", "clusterValue", "principalAssignmentValue")

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 := clusterprincipalassignments.NewClusterID("12345678-1234-9876-4563-123456789012", "example-resource-group", "clusterValue")

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 ValidateClusterID

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

ValidateClusterID checks that 'input' can be parsed as a Cluster ID

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

type ClusterId struct {
	SubscriptionId    string
	ResourceGroupName string
	ClusterName       string
}

ClusterId is a struct representing the Resource ID for a Cluster

func NewClusterID

func NewClusterID(subscriptionId string, resourceGroupName string, clusterName string) ClusterId

NewClusterID returns a new ClusterId struct

func ParseClusterID

func ParseClusterID(input string) (*ClusterId, error)

ParseClusterID parses 'input' into a ClusterId

func ParseClusterIDInsensitively

func ParseClusterIDInsensitively(input string) (*ClusterId, error)

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

func (ClusterId) ID

func (id ClusterId) ID() string

ID returns the formatted Cluster ID

func (ClusterId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Cluster ID

func (ClusterId) String

func (id ClusterId) String() string

String returns a human-readable description of this Cluster ID

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 autorest.Client
	// contains filtered or unexported fields
}

func NewClusterPrincipalAssignmentsClientWithBaseURI

func NewClusterPrincipalAssignmentsClientWithBaseURI(endpoint string) ClusterPrincipalAssignmentsClient

func (ClusterPrincipalAssignmentsClient) CheckNameAvailability

CheckNameAvailability ...

func (ClusterPrincipalAssignmentsClient) CreateOrUpdate

CreateOrUpdate ...

func (ClusterPrincipalAssignmentsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ClusterPrincipalAssignmentsClient) Delete

Delete ...

func (ClusterPrincipalAssignmentsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ClusterPrincipalAssignmentsClient) Get

Get ...

func (ClusterPrincipalAssignmentsClient) List

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"
	ClusterPrincipalRoleAllDatabasesViewer ClusterPrincipalRole = "AllDatabasesViewer"
)

type CreateOrUpdateOperationResponse

type CreateOrUpdateOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       polling.LongRunningPoller
	HttpResponse *http.Response
}

type GetOperationResponse

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

type ListOperationResponse

type ListOperationResponse struct {
	HttpResponse *http.Response
	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) 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"
)

type PrincipalType

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

type ProvisioningState

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

type Reason

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

Jump to

Keyboard shortcuts

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