README
¶
github.com/hashicorp/go-azure-sdk/resource-manager/cosmosdb/2024-05-15/privatelinkresources Documentation
The privatelinkresources SDK allows for interaction with the Azure Resource Manager Service cosmosdb (API Version 2024-05-15).
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/cosmosdb/2024-05-15/privatelinkresources"
Client Initialization
client := privatelinkresources.NewPrivateLinkResourcesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer
Example Usage: PrivateLinkResourcesClient.Get
ctx := context.TODO()
id := privatelinkresources.NewPrivateLinkResourceID("12345678-1234-9876-4563-123456789012", "example-resource-group", "databaseAccountValue", "privateLinkResourceValue")
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: PrivateLinkResourcesClient.ListByDatabaseAccount
ctx := context.TODO()
id := privatelinkresources.NewDatabaseAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "databaseAccountValue")
read, err := client.ListByDatabaseAccount(ctx, id)
if err != nil {
// handle the error
}
if model := read.Model; model != nil {
// do something with the model/response object
}
Documentation
¶
Index ¶
- func ValidateDatabaseAccountID(input interface{}, key string) (warnings []string, errors []error)
- func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
- type DatabaseAccountId
- type GetOperationResponse
- type ListByDatabaseAccountOperationResponse
- type PrivateLinkResource
- type PrivateLinkResourceId
- func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, databaseAccountName string, ...) PrivateLinkResourceId
- func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
- func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)
- type PrivateLinkResourceListResult
- type PrivateLinkResourceProperties
- type PrivateLinkResourcesClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ValidateDatabaseAccountID ¶
ValidateDatabaseAccountID checks that 'input' can be parsed as a Database Account ID
func ValidatePrivateLinkResourceID ¶
func ValidatePrivateLinkResourceID(input interface{}, key string) (warnings []string, errors []error)
ValidatePrivateLinkResourceID checks that 'input' can be parsed as a Private Link Resource ID
Types ¶
type DatabaseAccountId ¶
type DatabaseAccountId struct {
SubscriptionId string
ResourceGroupName string
DatabaseAccountName string
}
DatabaseAccountId is a struct representing the Resource ID for a Database Account
func NewDatabaseAccountID ¶
func NewDatabaseAccountID(subscriptionId string, resourceGroupName string, databaseAccountName string) DatabaseAccountId
NewDatabaseAccountID returns a new DatabaseAccountId struct
func ParseDatabaseAccountID ¶
func ParseDatabaseAccountID(input string) (*DatabaseAccountId, error)
ParseDatabaseAccountID parses 'input' into a DatabaseAccountId
func ParseDatabaseAccountIDInsensitively ¶
func ParseDatabaseAccountIDInsensitively(input string) (*DatabaseAccountId, error)
ParseDatabaseAccountIDInsensitively parses 'input' case-insensitively into a DatabaseAccountId note: this method should only be used for API response data and not user input
func (*DatabaseAccountId) FromParseResult ¶
func (id *DatabaseAccountId) FromParseResult(input resourceids.ParseResult) error
func (DatabaseAccountId) ID ¶
func (id DatabaseAccountId) ID() string
ID returns the formatted Database Account ID
func (DatabaseAccountId) Segments ¶
func (id DatabaseAccountId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Database Account ID
func (DatabaseAccountId) String ¶
func (id DatabaseAccountId) String() string
String returns a human-readable description of this Database Account ID
type GetOperationResponse ¶
type GetOperationResponse struct {
HttpResponse *http.Response
OData *odata.OData
Model *PrivateLinkResource
}
type ListByDatabaseAccountOperationResponse ¶
type ListByDatabaseAccountOperationResponse struct {
HttpResponse *http.Response
OData *odata.OData
Model *PrivateLinkResourceListResult
}
type PrivateLinkResource ¶
type PrivateLinkResource struct {
Id *string `json:"id,omitempty"`
Name *string `json:"name,omitempty"`
Properties *PrivateLinkResourceProperties `json:"properties,omitempty"`
Type *string `json:"type,omitempty"`
}
type PrivateLinkResourceId ¶
type PrivateLinkResourceId struct {
SubscriptionId string
ResourceGroupName string
DatabaseAccountName string
PrivateLinkResourceName string
}
PrivateLinkResourceId is a struct representing the Resource ID for a Private Link Resource
func NewPrivateLinkResourceID ¶
func NewPrivateLinkResourceID(subscriptionId string, resourceGroupName string, databaseAccountName string, privateLinkResourceName string) PrivateLinkResourceId
NewPrivateLinkResourceID returns a new PrivateLinkResourceId struct
func ParsePrivateLinkResourceID ¶
func ParsePrivateLinkResourceID(input string) (*PrivateLinkResourceId, error)
ParsePrivateLinkResourceID parses 'input' into a PrivateLinkResourceId
func ParsePrivateLinkResourceIDInsensitively ¶
func ParsePrivateLinkResourceIDInsensitively(input string) (*PrivateLinkResourceId, error)
ParsePrivateLinkResourceIDInsensitively parses 'input' case-insensitively into a PrivateLinkResourceId note: this method should only be used for API response data and not user input
func (*PrivateLinkResourceId) FromParseResult ¶
func (id *PrivateLinkResourceId) FromParseResult(input resourceids.ParseResult) error
func (PrivateLinkResourceId) ID ¶
func (id PrivateLinkResourceId) ID() string
ID returns the formatted Private Link Resource ID
func (PrivateLinkResourceId) Segments ¶
func (id PrivateLinkResourceId) Segments() []resourceids.Segment
Segments returns a slice of Resource ID Segments which comprise this Private Link Resource ID
func (PrivateLinkResourceId) String ¶
func (id PrivateLinkResourceId) String() string
String returns a human-readable description of this Private Link Resource ID
type PrivateLinkResourceListResult ¶
type PrivateLinkResourceListResult struct {
Value *[]PrivateLinkResource `json:"value,omitempty"`
}
type PrivateLinkResourcesClient ¶
type PrivateLinkResourcesClient struct {
Client *resourcemanager.Client
}
func NewPrivateLinkResourcesClientWithBaseURI ¶
func NewPrivateLinkResourcesClientWithBaseURI(sdkApi sdkEnv.Api) (*PrivateLinkResourcesClient, error)
func (PrivateLinkResourcesClient) Get ¶
func (c PrivateLinkResourcesClient) Get(ctx context.Context, id PrivateLinkResourceId) (result GetOperationResponse, err error)
Get ...
func (PrivateLinkResourcesClient) ListByDatabaseAccount ¶
func (c PrivateLinkResourcesClient) ListByDatabaseAccount(ctx context.Context, id DatabaseAccountId) (result ListByDatabaseAccountOperationResponse, err error)
ListByDatabaseAccount ...
Source Files