manageddatabaseschemas

README

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

The manageddatabaseschemas 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/manageddatabaseschemas"

Client Initialization

client := manageddatabaseschemas.NewManagedDatabaseSchemasClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ManagedDatabaseSchemasClient.Get

ctx := context.TODO()
id := manageddatabaseschemas.NewDatabaseSchemaID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "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: ManagedDatabaseSchemasClient.ListByDatabase

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

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

Documentation

Index

• func ValidateDatabaseSchemaID(input interface{}, key string) (warnings []string, errors []error)
• type DatabaseSchemaId
  • func NewDatabaseSchemaID(subscriptionId string, resourceGroupName string, managedInstanceName string, ...) DatabaseSchemaId
  • func ParseDatabaseSchemaID(input string) (*DatabaseSchemaId, error)
  • func ParseDatabaseSchemaIDInsensitively(input string) (*DatabaseSchemaId, error)
  • func (id *DatabaseSchemaId) FromParseResult(input resourceids.ParseResult) error
  • func (id DatabaseSchemaId) ID() string
  • func (id DatabaseSchemaId) Segments() []resourceids.Segment
  • func (id DatabaseSchemaId) String() string
• 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 ManagedDatabaseSchemasClient
  • func NewManagedDatabaseSchemasClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabaseSchemasClient, error)
  • func (c ManagedDatabaseSchemasClient) Get(ctx context.Context, id DatabaseSchemaId) (result GetOperationResponse, err error)
  • func (c ManagedDatabaseSchemasClient) ListByDatabase(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, ...) (result ListByDatabaseOperationResponse, err error)
  • func (c ManagedDatabaseSchemasClient) ListByDatabaseComplete(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, ...) (ListByDatabaseCompleteResult, error)
  • func (c ManagedDatabaseSchemasClient) ListByDatabaseCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceDatabaseId, ...) (result ListByDatabaseCompleteResult, err error)
• type Resource
• type ResourceOperationPredicate
  • func (p ResourceOperationPredicate) Matches(input Resource) bool

Functions

func ValidateDatabaseSchemaID

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

ValidateDatabaseSchemaID checks that 'input' can be parsed as a Database Schema ID

Types

type DatabaseSchemaId

type DatabaseSchemaId struct {
	SubscriptionId      string
	ResourceGroupName   string
	ManagedInstanceName string
	DatabaseName        string
	SchemaName          string
}

DatabaseSchemaId is a struct representing the Resource ID for a Database Schema

func NewDatabaseSchemaID

func NewDatabaseSchemaID(subscriptionId string, resourceGroupName string, managedInstanceName string, databaseName string, schemaName string) DatabaseSchemaId

NewDatabaseSchemaID returns a new DatabaseSchemaId struct

func ParseDatabaseSchemaID

func ParseDatabaseSchemaID(input string) (*DatabaseSchemaId, error)

ParseDatabaseSchemaID parses 'input' into a DatabaseSchemaId

func ParseDatabaseSchemaIDInsensitively

func ParseDatabaseSchemaIDInsensitively(input string) (*DatabaseSchemaId, error)

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

func (*DatabaseSchemaId) FromParseResult

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

func (DatabaseSchemaId) ID

func (id DatabaseSchemaId) ID() string

ID returns the formatted Database Schema ID

func (DatabaseSchemaId) Segments

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

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

func (DatabaseSchemaId) String

func (id DatabaseSchemaId) String() string

String returns a human-readable description of this Database Schema ID

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 ManagedDatabaseSchemasClient

type ManagedDatabaseSchemasClient struct {
	Client *resourcemanager.Client
}

func NewManagedDatabaseSchemasClientWithBaseURI

func NewManagedDatabaseSchemasClientWithBaseURI(sdkApi sdkEnv.Api) (*ManagedDatabaseSchemasClient, error)

func (ManagedDatabaseSchemasClient) Get

func (c ManagedDatabaseSchemasClient) Get(ctx context.Context, id DatabaseSchemaId) (result GetOperationResponse, err error)

Get ...

func (ManagedDatabaseSchemasClient) ListByDatabase

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

ListByDatabase ...

func (ManagedDatabaseSchemasClient) ListByDatabaseComplete

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

ListByDatabaseComplete retrieves all the results into a single object

func (ManagedDatabaseSchemasClient) ListByDatabaseCompleteMatchingPredicate

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

ListByDatabaseCompleteMatchingPredicate retrieves all the results and then applies the predicate

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