databaseextensions

package
v0.20240315.1103122 Latest Latest
Warning

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

 Go to latest Published: Mar 15, 2024 License: MPL-2.0 Imports: 12 Imported by: 0

README

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

The databaseextensions SDK allows for interaction with the Azure Resource Manager Service sql (API Version 2023-02-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-02-01-preview/databaseextensions"

Client Initialization

client := databaseextensions.NewDatabaseExtensionsClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseExtensionsClient.CreateOrUpdate

ctx := context.TODO()
id := databaseextensions.NewExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "extensionValue")

payload := databaseextensions.DatabaseExtensions{
	// ...
}


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

Example Usage: DatabaseExtensionsClient.Get

ctx := context.TODO()
id := databaseextensions.NewExtensionID("12345678-1234-9876-4563-123456789012", "example-resource-group", "serverValue", "databaseValue", "extensionValue")

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: DatabaseExtensionsClient.ListByDatabase

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

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

func PossibleValuesForOperationMode() []string

func PossibleValuesForStorageKeyType 

func PossibleValuesForStorageKeyType() []string

func ValidateExtensionID 

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

ValidateExtensionID checks that 'input' can be parsed as a Extension ID

Types

type CreateOrUpdateOperationResponse 

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

type DatabaseExtensions 

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

type DatabaseExtensionsClient 

type DatabaseExtensionsClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseExtensionsClientWithBaseURI 

func NewDatabaseExtensionsClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseExtensionsClient, error)

func (DatabaseExtensionsClient) CreateOrUpdate 

func (c DatabaseExtensionsClient) CreateOrUpdate(ctx context.Context, id ExtensionId, input DatabaseExtensions) (result CreateOrUpdateOperationResponse, err error)

CreateOrUpdate ...

func (DatabaseExtensionsClient) CreateOrUpdateThenPoll 

func (c DatabaseExtensionsClient) CreateOrUpdateThenPoll(ctx context.Context, id ExtensionId, input DatabaseExtensions) error

CreateOrUpdateThenPoll performs CreateOrUpdate then polls until it's completed

func (DatabaseExtensionsClient) Get 

func (c DatabaseExtensionsClient) Get(ctx context.Context, id ExtensionId) (result GetOperationResponse, err error)

Get ...

func (DatabaseExtensionsClient) ListByDatabase 

func (c DatabaseExtensionsClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId) (result ListByDatabaseOperationResponse, err error)

ListByDatabase ...

func (DatabaseExtensionsClient) ListByDatabaseComplete 

func (c DatabaseExtensionsClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (DatabaseExtensionsClient) ListByDatabaseCompleteMatchingPredicate 

func (c DatabaseExtensionsClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, predicate ImportExportExtensionsOperationResultOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

type DatabaseExtensionsProperties 

type DatabaseExtensionsProperties struct {
	AdministratorLogin         *string                   `json:"administratorLogin,omitempty"`
	AdministratorLoginPassword *string                   `json:"administratorLoginPassword,omitempty"`
	AuthenticationType         *string                   `json:"authenticationType,omitempty"`
	DatabaseEdition            *string                   `json:"databaseEdition,omitempty"`
	MaxSizeBytes               *string                   `json:"maxSizeBytes,omitempty"`
	NetworkIsolation           *NetworkIsolationSettings `json:"networkIsolation,omitempty"`
	OperationMode              OperationMode             `json:"operationMode"`
	ServiceObjectiveName       *string                   `json:"serviceObjectiveName,omitempty"`
	StorageKey                 string                    `json:"storageKey"`
	StorageKeyType             StorageKeyType            `json:"storageKeyType"`
	StorageUri                 string                    `json:"storageUri"`
}

type ExtensionId 

type ExtensionId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
	ExtensionName     string
}

ExtensionId is a struct representing the Resource ID for a Extension

func NewExtensionID 

func NewExtensionID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, extensionName string) ExtensionId

NewExtensionID returns a new ExtensionId struct

func ParseExtensionID 

func ParseExtensionID(input string) (*ExtensionId, error)

ParseExtensionID parses 'input' into a ExtensionId

func ParseExtensionIDInsensitively 

func ParseExtensionIDInsensitively(input string) (*ExtensionId, error)

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

func (*ExtensionId) FromParseResult 

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

func (ExtensionId) ID 

func (id ExtensionId) ID() string

ID returns the formatted Extension ID

func (ExtensionId) Segments 

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

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

func (ExtensionId) String 

func (id ExtensionId) String() string

String returns a human-readable description of this Extension ID

type GetOperationResponse 

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

type ImportExportExtensionsOperationResult 

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

type ImportExportExtensionsOperationResultOperationPredicate 

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

func (ImportExportExtensionsOperationResultOperationPredicate) Matches 

func (p ImportExportExtensionsOperationResultOperationPredicate) Matches(input ImportExportExtensionsOperationResult) bool

type ImportExportExtensionsOperationResultProperties 

type ImportExportExtensionsOperationResultProperties struct {
	BlobUri                    *string                                   `json:"blobUri,omitempty"`
	DatabaseName               *string                                   `json:"databaseName,omitempty"`
	ErrorMessage               *string                                   `json:"errorMessage,omitempty"`
	LastModifiedTime           *string                                   `json:"lastModifiedTime,omitempty"`
	PrivateEndpointConnections *[]PrivateEndpointConnectionRequestStatus `json:"privateEndpointConnections,omitempty"`
	QueuedTime                 *string                                   `json:"queuedTime,omitempty"`
	RequestId                  *string                                   `json:"requestId,omitempty"`
	RequestType                *string                                   `json:"requestType,omitempty"`
	ServerName                 *string                                   `json:"serverName,omitempty"`
	Status                     *string                                   `json:"status,omitempty"`
}

type ListByDatabaseCompleteResult 

type ListByDatabaseCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []ImportExportExtensionsOperationResult
}

type ListByDatabaseOperationResponse 

type ListByDatabaseOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]ImportExportExtensionsOperationResult
}

type NetworkIsolationSettings 

type NetworkIsolationSettings struct {
	SqlServerResourceId      *string `json:"sqlServerResourceId,omitempty"`
	StorageAccountResourceId *string `json:"storageAccountResourceId,omitempty"`
}

type OperationMode 

type OperationMode string
const (
	OperationModeExport         OperationMode = "Export"
	OperationModeImport         OperationMode = "Import"
	OperationModePolybaseImport OperationMode = "PolybaseImport"
)

func (*OperationMode) UnmarshalJSON 

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

type PrivateEndpointConnectionRequestStatus 

type PrivateEndpointConnectionRequestStatus struct {
	PrivateEndpointConnectionName *string `json:"privateEndpointConnectionName,omitempty"`
	PrivateLinkServiceId          *string `json:"privateLinkServiceId,omitempty"`
	Status                        *string `json:"status,omitempty"`
}

type StorageKeyType 

type StorageKeyType string
const (
	StorageKeyTypeSharedAccessKey  StorageKeyType = "SharedAccessKey"
	StorageKeyTypeStorageAccessKey StorageKeyType = "StorageAccessKey"
)

func (*StorageKeyType) UnmarshalJSON 

func (s *StorageKeyType) 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.