serverazureadadministrators

package
v0.20241023.1122425 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: MPL-2.0 Imports: 11 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-08-01-preview/serverazureadadministrators Documentation

The serverazureadadministrators SDK allows for interaction with Azure Resource Manager sql (API Version 2023-08-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-helpers/resourcemanager/commonids"
import "github.com/hashicorp/go-azure-sdk/resource-manager/sql/2023-08-01-preview/serverazureadadministrators"

Client Initialization

client := serverazureadadministrators.NewServerAzureADAdministratorsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServerAzureADAdministratorsClient.CreateOrUpdate

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

payload := serverazureadadministrators.ServerAzureADAdministrator{
	// ...
}


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

Example Usage: ServerAzureADAdministratorsClient.Delete

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

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

Example Usage: ServerAzureADAdministratorsClient.Get

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

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

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

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

Types

type AdministratorProperties 

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

type AdministratorType 

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

func (*AdministratorType) UnmarshalJSON 

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

type CreateOrUpdateOperationResponse 

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

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

type ListByServerCompleteResult 

type ListByServerCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ServerAzureADAdministrator
}

type ListByServerCustomPager 

type ListByServerCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByServerCustomPager) NextPageLink() *odata.Link

type ListByServerOperationResponse 

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

type ServerAzureADAdministrator 

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

type ServerAzureADAdministratorOperationPredicate 

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

func (ServerAzureADAdministratorOperationPredicate) Matches 

func (p ServerAzureADAdministratorOperationPredicate) Matches(input ServerAzureADAdministrator) bool

type ServerAzureADAdministratorsClient 

type ServerAzureADAdministratorsClient struct {
	Client *resourcemanager.Client
}

func NewServerAzureADAdministratorsClientWithBaseURI 

func NewServerAzureADAdministratorsClientWithBaseURI(sdkApi sdkEnv.Api) (*ServerAzureADAdministratorsClient, error)

func (ServerAzureADAdministratorsClient) CreateOrUpdate 

func (c ServerAzureADAdministratorsClient) CreateOrUpdate(ctx context.Context, id commonids.SqlServerId, input ServerAzureADAdministrator) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (ServerAzureADAdministratorsClient) CreateOrUpdateThenPoll 

func (c ServerAzureADAdministratorsClient) CreateOrUpdateThenPoll(ctx context.Context, id commonids.SqlServerId, input ServerAzureADAdministrator) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (ServerAzureADAdministratorsClient) Delete 

func (c ServerAzureADAdministratorsClient) Delete(ctx context.Context, id commonids.SqlServerId) (result DeleteOperationResponse, err error)

Delete ...

func (ServerAzureADAdministratorsClient) DeleteThenPoll 

func (c ServerAzureADAdministratorsClient) DeleteThenPoll(ctx context.Context, id commonids.SqlServerId) error

DeleteThenPoll performs Delete then polls until it's completed

func (ServerAzureADAdministratorsClient) Get 

func (c ServerAzureADAdministratorsClient) Get(ctx context.Context, id commonids.SqlServerId) (result GetOperationResponse, err error)

Get ...

func (ServerAzureADAdministratorsClient) ListByServer 

func (c ServerAzureADAdministratorsClient) ListByServer(ctx context.Context, id commonids.SqlServerId) (result ListByServerOperationResponse, err error)

ListByServer ...

func (ServerAzureADAdministratorsClient) ListByServerComplete 

func (c ServerAzureADAdministratorsClient) ListByServerComplete(ctx context.Context, id commonids.SqlServerId) (ListByServerCompleteResult, error)

ListByServerComplete retrieves all the results into a single object

func (ServerAzureADAdministratorsClient) ListByServerCompleteMatchingPredicate 

func (c ServerAzureADAdministratorsClient) ListByServerCompleteMatchingPredicate(ctx context.Context, id commonids.SqlServerId, predicate ServerAzureADAdministratorOperationPredicate) (result ListByServerCompleteResult, err error)

ListByServerCompleteMatchingPredicate retrieves all the results and then applies the predicate

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.