managedinstanceadministrators

package
v0.20230803.1074127 Latest Latest
Warning

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

Go to latest
Published: Aug 3, 2023 License: MPL-2.0 Imports: 11 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2017-03-01-preview/managedinstanceadministrators Documentation

The managedinstanceadministrators SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2017-03-01-preview).

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/sql/2017-03-01-preview/managedinstanceadministrators"

Client Initialization

client := managedinstanceadministrators.NewManagedInstanceAdministratorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedInstanceAdministratorsClient.CreateOrUpdate

ctx := context.TODO()
id := managedinstanceadministrators.NewManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

payload := managedinstanceadministrators.ManagedInstanceAdministrator{
	// ...
}


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

Example Usage: ManagedInstanceAdministratorsClient.Delete

ctx := context.TODO()
id := managedinstanceadministrators.NewManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

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

Example Usage: ManagedInstanceAdministratorsClient.Get

ctx := context.TODO()
id := managedinstanceadministrators.NewManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

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: ManagedInstanceAdministratorsClient.ListByInstance

ctx := context.TODO()
id := managedinstanceadministrators.NewManagedInstanceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue")

// alternatively `client.ListByInstance(ctx, id)` can be used to do batched pagination
items, err := client.ListByInstanceComplete(ctx, id)
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForManagedInstanceAdministratorType

func PossibleValuesForManagedInstanceAdministratorType() []string

func ValidateManagedInstanceID

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

ValidateManagedInstanceID checks that 'input' can be parsed as a Managed Instance ID

Types

type CreateOrUpdateOperationResponse

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

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        *ManagedInstanceAdministrator
}

type ListByInstanceCompleteResult

type ListByInstanceCompleteResult struct {
	Items []ManagedInstanceAdministrator
}

type ListByInstanceOperationResponse

type ListByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ManagedInstanceAdministrator
}

type ManagedInstanceAdministrator

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

type ManagedInstanceAdministratorOperationPredicate

type ManagedInstanceAdministratorOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (ManagedInstanceAdministratorOperationPredicate) Matches

type ManagedInstanceAdministratorProperties

type ManagedInstanceAdministratorProperties struct {
	AdministratorType ManagedInstanceAdministratorType `json:"administratorType"`
	Login             string                           `json:"login"`
	Sid               string                           `json:"sid"`
	TenantId          *string                          `json:"tenantId,omitempty"`
}

type ManagedInstanceAdministratorType

type ManagedInstanceAdministratorType string
const (
	ManagedInstanceAdministratorTypeActiveDirectory ManagedInstanceAdministratorType = "ActiveDirectory"
)

func (*ManagedInstanceAdministratorType) UnmarshalJSON

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

type ManagedInstanceAdministratorsClient

type ManagedInstanceAdministratorsClient struct {
	Client *resourcemanager.Client
}

func NewManagedInstanceAdministratorsClientWithBaseURI

func NewManagedInstanceAdministratorsClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedInstanceAdministratorsClient, error)

func (ManagedInstanceAdministratorsClient) CreateOrUpdate

CreateOrUpdate ...

func (ManagedInstanceAdministratorsClient) CreateOrUpdateThenPoll

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ManagedInstanceAdministratorsClient) Delete

Delete ...

func (ManagedInstanceAdministratorsClient) DeleteThenPoll

DeleteThenPoll performs Delete then polls until it's completed

func (ManagedInstanceAdministratorsClient) Get

Get ...

func (ManagedInstanceAdministratorsClient) ListByInstance

ListByInstance ...

func (ManagedInstanceAdministratorsClient) ListByInstanceComplete

ListByInstanceComplete retrieves all the results into a single object

func (ManagedInstanceAdministratorsClient) ListByInstanceCompleteMatchingPredicate

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type ManagedInstanceId

type ManagedInstanceId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
}

ManagedInstanceId is a struct representing the Resource ID for a Managed Instance

func NewManagedInstanceID

func NewManagedInstanceID(subscriptionId string, resourceGroupName string, managedInstanceName string) ManagedInstanceId

NewManagedInstanceID returns a new ManagedInstanceId struct

func ParseManagedInstanceID

func ParseManagedInstanceID(input string) (*ManagedInstanceId, error)

ParseManagedInstanceID parses 'input' into a ManagedInstanceId

func ParseManagedInstanceIDInsensitively

func ParseManagedInstanceIDInsensitively(input string) (*ManagedInstanceId, error)

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

func (ManagedInstanceId) ID

func (id ManagedInstanceId) ID() string

ID returns the formatted Managed Instance ID

func (ManagedInstanceId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Managed Instance ID

func (ManagedInstanceId) String

func (id ManagedInstanceId) String() string

String returns a human-readable description of this Managed Instance ID

Jump to

Keyboard shortcuts

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