azureadadministrators

package
v0.20230824.1010308 Latest Latest
Warning

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

 Go to latest Published: Aug 24, 2023 License: MPL-2.0 Imports: 12 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/mysql/2021-12-01-preview/azureadadministrators Documentation

The azureadadministrators SDK allows for interaction with the Azure Resource Manager Service mysql (API Version 2021-12-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/mysql/2021-12-01-preview/azureadadministrators"

Client Initialization

client := azureadadministrators.NewAzureADAdministratorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: AzureADAdministratorsClient.CreateOrUpdate

ctx := context.TODO()
id := azureadadministrators.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

payload := azureadadministrators.AzureADAdministrator{
	// ...
}


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

Example Usage: AzureADAdministratorsClient.Delete

ctx := context.TODO()
id := azureadadministrators.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

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

Example Usage: AzureADAdministratorsClient.Get

ctx := context.TODO()
id := azureadadministrators.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

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: AzureADAdministratorsClient.ListByServer

ctx := context.TODO()
id := azureadadministrators.NewFlexibleServerID("12345678-1234-9876-4563-123456789012", "example-resource-group", "flexibleServerValue")

// alternatively `client.ListByServer(ctx, id)` can be used to do batched pagination
items, err := client.ListByServerComplete(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 PossibleValuesForAdministratorType 

func PossibleValuesForAdministratorType() []string

func ValidateFlexibleServerID 

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

ValidateFlexibleServerID checks that 'input' can be parsed as a Flexible Server ID

Types

type AdministratorProperties 

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

type AdministratorType 

type AdministratorType string
const (
	AdministratorTypeActiveDirectory AdministratorType = "ActiveDirectory"
)

func (*AdministratorType) UnmarshalJSON added in v0.20230725.1205316 

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

type AzureADAdministrator 

type AzureADAdministrator struct {
	Id         *string                  `json:"id,omitempty"`
	Name       *string                  `json:"name,omitempty"`
	Properties *AdministratorProperties `json:"properties,omitempty"`
	SystemData *systemdata.SystemData   `json:"systemData,omitempty"`
	Type       *string                  `json:"type,omitempty"`
}

type AzureADAdministratorOperationPredicate 

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

func (AzureADAdministratorOperationPredicate) Matches 

func (p AzureADAdministratorOperationPredicate) Matches(input AzureADAdministrator) bool

type AzureADAdministratorsClient 

type AzureADAdministratorsClient struct {
	Client *resourcemanager.Client
}

func NewAzureADAdministratorsClientWithBaseURI 

func NewAzureADAdministratorsClientWithBaseURI(sdkApi sdkEnv.Api) (*AzureADAdministratorsClient, error)

func (AzureADAdministratorsClient) CreateOrUpdate 

func (c AzureADAdministratorsClient) CreateOrUpdate(ctx context.Context, id FlexibleServerId, input AzureADAdministrator) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (AzureADAdministratorsClient) CreateOrUpdateThenPoll 

func (c AzureADAdministratorsClient) CreateOrUpdateThenPoll(ctx context.Context, id FlexibleServerId, input AzureADAdministrator) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (AzureADAdministratorsClient) Delete 

func (c AzureADAdministratorsClient) Delete(ctx context.Context, id FlexibleServerId) (result DeleteOperationResponse, err error)

Delete ...

func (AzureADAdministratorsClient) DeleteThenPoll 

func (c AzureADAdministratorsClient) DeleteThenPoll(ctx context.Context, id FlexibleServerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (AzureADAdministratorsClient) Get 

func (c AzureADAdministratorsClient) Get(ctx context.Context, id FlexibleServerId) (result GetOperationResponse, err error)

Get ...

func (AzureADAdministratorsClient) ListByServer 

func (c AzureADAdministratorsClient) ListByServer(ctx context.Context, id FlexibleServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (AzureADAdministratorsClient) ListByServerComplete 

func (c AzureADAdministratorsClient) ListByServerComplete(ctx context.Context, id FlexibleServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (AzureADAdministratorsClient) ListByServerCompleteMatchingPredicate 

func (c AzureADAdministratorsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id FlexibleServerId, predicate AzureADAdministratorOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

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 FlexibleServerId 

type FlexibleServerId struct {
	SubscriptionId     string
	ResourceGroupName  string
	FlexibleServerName string
}

FlexibleServerId is a struct representing the Resource ID for a Flexible Server

func NewFlexibleServerID 

func NewFlexibleServerID(subscriptionId string, resourceGroupName string, flexibleServerName string) FlexibleServerId

NewFlexibleServerID returns a new FlexibleServerId struct

func ParseFlexibleServerID 

func ParseFlexibleServerID(input string) (*FlexibleServerId, error)

ParseFlexibleServerID parses 'input' into a FlexibleServerId

func ParseFlexibleServerIDInsensitively 

func ParseFlexibleServerIDInsensitively(input string) (*FlexibleServerId, error)

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

func (FlexibleServerId) ID 

func (id FlexibleServerId) ID() string

ID returns the formatted Flexible Server ID

func (FlexibleServerId) Segments 

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

Segments returns a slice of Resource ID Segments which comprise this Flexible Server ID

func (FlexibleServerId) String 

func (id FlexibleServerId) String() string

String returns a human-readable description of this Flexible Server ID

type GetOperationResponse 

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

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	Items []AzureADAdministrator
}

type ListByServerOperationResponse 

type ListByServerOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]AzureADAdministrator
}

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.