databaseschemas

README

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

The databaseschemas 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-sdk/resource-manager/sql/2023-02-01-preview/databaseschemas"

Client Initialization

client := databaseschemas.NewDatabaseSchemasClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: DatabaseSchemasClient.Get

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

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

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

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

Documentation

Index

• func ValidateSchemaID(input interface{}, key string) (warnings []string, errors []error)
• type DatabaseSchemasClient
  • func NewDatabaseSchemasClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseSchemasClient, error)
  • func (c DatabaseSchemasClient) Get(ctx context.Context, id SchemaId) (result GetOperationResponse, err error)
  • func (c DatabaseSchemasClient) ListByDatabase(ctx context.Context, id commonids.SqlDatabaseId, ...) (result ListByDatabaseOperationResponse, err error)
  • func (c DatabaseSchemasClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId, ...) (ListByDatabaseCompleteResult, error)
  • func (c DatabaseSchemasClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, ...) (result ListByDatabaseCompleteResult, err error)
• type GetOperationResponse
• type ListByDatabaseCompleteResult
• type ListByDatabaseOperationOptions
  • func DefaultListByDatabaseOperationOptions() ListByDatabaseOperationOptions
  • func (o ListByDatabaseOperationOptions) ToHeaders() *client.Headers
  • func (o ListByDatabaseOperationOptions) ToOData() *odata.Query
  • func (o ListByDatabaseOperationOptions) ToQuery() *client.QueryParams
• type ListByDatabaseOperationResponse
• type Resource
• type ResourceOperationPredicate
  • func (p ResourceOperationPredicate) Matches(input Resource) bool
• type SchemaId
  • func NewSchemaID(subscriptionId string, resourceGroupName string, serverName string, ...) SchemaId
  • func ParseSchemaID(input string) (*SchemaId, error)
  • func ParseSchemaIDInsensitively(input string) (*SchemaId, error)
  • func (id *SchemaId) FromParseResult(input resourceids.ParseResult) error
  • func (id SchemaId) ID() string
  • func (id SchemaId) Segments() []resourceids.Segment
  • func (id SchemaId) String() string

Functions

func ValidateSchemaID

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

ValidateSchemaID checks that 'input' can be parsed as a Schema ID

Types

type DatabaseSchemasClient

type DatabaseSchemasClient struct {
	Client *resourcemanager.Client
}

func NewDatabaseSchemasClientWithBaseURI

func NewDatabaseSchemasClientWithBaseURI(sdkApi sdkEnv.Api) (*DatabaseSchemasClient, error)

func (DatabaseSchemasClient) Get

func (c DatabaseSchemasClient) Get(ctx context.Context, id SchemaId) (result GetOperationResponse, err error)

Get ...

func (DatabaseSchemasClient) ListByDatabase

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

ListByDatabase ...

func (DatabaseSchemasClient) ListByDatabaseComplete

func (c DatabaseSchemasClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlDatabaseId, options ListByDatabaseOperationOptions) (ListByDatabaseCompleteResult, error)

ListByDatabaseComplete retrieves all the results into a single object

func (DatabaseSchemasClient) ListByDatabaseCompleteMatchingPredicate

func (c DatabaseSchemasClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlDatabaseId, options ListByDatabaseOperationOptions, predicate ResourceOperationPredicate) (result ListByDatabaseCompleteResult, err error)

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListByDatabaseCompleteResult

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

type ListByDatabaseOperationOptions

type ListByDatabaseOperationOptions struct {
	Filter *string
}

func DefaultListByDatabaseOperationOptions

func DefaultListByDatabaseOperationOptions() ListByDatabaseOperationOptions

func (ListByDatabaseOperationOptions) ToHeaders

func (o ListByDatabaseOperationOptions) ToHeaders() *client.Headers

func (ListByDatabaseOperationOptions) ToOData

func (o ListByDatabaseOperationOptions) ToOData() *odata.Query

func (ListByDatabaseOperationOptions) ToQuery

func (o ListByDatabaseOperationOptions) ToQuery() *client.QueryParams

type ListByDatabaseOperationResponse

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

type Resource

type Resource struct {
	Id   *string `json:"id,omitempty"`
	Name *string `json:"name,omitempty"`
	Type *string `json:"type,omitempty"`
}

type ResourceOperationPredicate

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

func (ResourceOperationPredicate) Matches

func (p ResourceOperationPredicate) Matches(input Resource) bool

type SchemaId

type SchemaId struct {
	SubscriptionId    string
	ResourceGroupName string
	ServerName        string
	DatabaseName      string
	SchemaName        string
}

SchemaId is a struct representing the Resource ID for a Schema

func NewSchemaID

func NewSchemaID(subscriptionId string, resourceGroupName string, serverName string, databaseName string, schemaName string) SchemaId

NewSchemaID returns a new SchemaId struct

func ParseSchemaID

func ParseSchemaID(input string) (*SchemaId, error)

ParseSchemaID parses 'input' into a SchemaId

func ParseSchemaIDInsensitively

func ParseSchemaIDInsensitively(input string) (*SchemaId, error)

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

func (*SchemaId) FromParseResult

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

func (SchemaId) ID

func (id SchemaId) ID() string

ID returns the formatted Schema ID

func (SchemaId) Segments

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

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

func (SchemaId) String

func (id SchemaId) String() string

String returns a human-readable description of this Schema ID