endpointcertificates

README

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

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

Client Initialization

client := endpointcertificates.NewEndpointCertificatesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: EndpointCertificatesClient.Get

ctx := context.TODO()
id := endpointcertificates.NewEndpointCertificateID("12345678-1234-9876-4563-123456789012", "example-resource-group", "managedInstanceValue", "endpointCertificateValue")

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: EndpointCertificatesClient.ListByInstance

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

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

Documentation

Index

• func ValidateEndpointCertificateID(input interface{}, key string) (warnings []string, errors []error)
• type EndpointCertificate
• type EndpointCertificateId
  • func NewEndpointCertificateID(subscriptionId string, resourceGroupName string, managedInstanceName string, ...) EndpointCertificateId
  • func ParseEndpointCertificateID(input string) (*EndpointCertificateId, error)
  • func ParseEndpointCertificateIDInsensitively(input string) (*EndpointCertificateId, error)
  • func (id *EndpointCertificateId) FromParseResult(input resourceids.ParseResult) error
  • func (id EndpointCertificateId) ID() string
  • func (id EndpointCertificateId) Segments() []resourceids.Segment
  • func (id EndpointCertificateId) String() string
• type EndpointCertificateOperationPredicate
  • func (p EndpointCertificateOperationPredicate) Matches(input EndpointCertificate) bool
• type EndpointCertificateProperties
• type EndpointCertificatesClient
  • func NewEndpointCertificatesClientWithBaseURI(sdkApi sdkEnv.Api) (*EndpointCertificatesClient, error)
  • func (c EndpointCertificatesClient) Get(ctx context.Context, id EndpointCertificateId) (result GetOperationResponse, err error)
  • func (c EndpointCertificatesClient) ListByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByInstanceOperationResponse, err error)
  • func (c EndpointCertificatesClient) ListByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByInstanceCompleteResult, error)
  • func (c EndpointCertificatesClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, ...) (result ListByInstanceCompleteResult, err error)
• type GetOperationResponse
• type ListByInstanceCompleteResult
• type ListByInstanceOperationResponse

Functions

func ValidateEndpointCertificateID

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

ValidateEndpointCertificateID checks that 'input' can be parsed as a Endpoint Certificate ID

Types

type EndpointCertificate

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

type EndpointCertificateId

type EndpointCertificateId struct {
	SubscriptionId          string
	ResourceGroupName       string
	ManagedInstanceName     string
	EndpointCertificateName string
}

EndpointCertificateId is a struct representing the Resource ID for a Endpoint Certificate

func NewEndpointCertificateID

func NewEndpointCertificateID(subscriptionId string, resourceGroupName string, managedInstanceName string, endpointCertificateName string) EndpointCertificateId

NewEndpointCertificateID returns a new EndpointCertificateId struct

func ParseEndpointCertificateID

func ParseEndpointCertificateID(input string) (*EndpointCertificateId, error)

ParseEndpointCertificateID parses 'input' into a EndpointCertificateId

func ParseEndpointCertificateIDInsensitively

func ParseEndpointCertificateIDInsensitively(input string) (*EndpointCertificateId, error)

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

func (*EndpointCertificateId) FromParseResult

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

func (EndpointCertificateId) ID

func (id EndpointCertificateId) ID() string

ID returns the formatted Endpoint Certificate ID

func (EndpointCertificateId) Segments

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

Segments returns a slice of Resource ID Segments which comprise this Endpoint Certificate ID

func (EndpointCertificateId) String

func (id EndpointCertificateId) String() string

String returns a human-readable description of this Endpoint Certificate ID

type EndpointCertificateOperationPredicate

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

func (EndpointCertificateOperationPredicate) Matches

func (p EndpointCertificateOperationPredicate) Matches(input EndpointCertificate) bool

type EndpointCertificateProperties

type EndpointCertificateProperties struct {
	PublicBlob *string `json:"publicBlob,omitempty"`
}

type EndpointCertificatesClient

type EndpointCertificatesClient struct {
	Client *resourcemanager.Client
}

func NewEndpointCertificatesClientWithBaseURI

func NewEndpointCertificatesClientWithBaseURI(sdkApi sdkEnv.Api) (*EndpointCertificatesClient, error)

func (EndpointCertificatesClient) Get

func (c EndpointCertificatesClient) Get(ctx context.Context, id EndpointCertificateId) (result GetOperationResponse, err error)

Get ...

func (EndpointCertificatesClient) ListByInstance

func (c EndpointCertificatesClient) ListByInstance(ctx context.Context, id commonids.SqlManagedInstanceId) (result ListByInstanceOperationResponse, err error)

ListByInstance ...

func (EndpointCertificatesClient) ListByInstanceComplete

func (c EndpointCertificatesClient) ListByInstanceComplete(ctx context.Context, id commonids.SqlManagedInstanceId) (ListByInstanceCompleteResult, error)

ListByInstanceComplete retrieves all the results into a single object

func (EndpointCertificatesClient) ListByInstanceCompleteMatchingPredicate

func (c EndpointCertificatesClient) ListByInstanceCompleteMatchingPredicate(ctx context.Context, id commonids.SqlManagedInstanceId, predicate EndpointCertificateOperationPredicate) (result ListByInstanceCompleteResult, err error)

ListByInstanceCompleteMatchingPredicate retrieves all the results and then applies the predicate

type GetOperationResponse

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

type ListByInstanceCompleteResult

type ListByInstanceCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []EndpointCertificate
}

type ListByInstanceOperationResponse

type ListByInstanceOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]EndpointCertificate
}