services

package
v0.20240920.1135249 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2024 License: MPL-2.0 Imports: 13 Imported by: 0

README

github.com/hashicorp/go-azure-sdk/resource-manager/cosmosdb/2024-05-15/services Documentation

The services SDK allows for interaction with Azure Resource Manager 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/services"

Client Initialization

client := services.NewServicesClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: ServicesClient.ServiceList

ctx := context.TODO()
id := services.NewDatabaseAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "accountName")

read, err := client.ServiceList(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDedicatedGatewayType 

func PossibleValuesForDedicatedGatewayType() []string

func PossibleValuesForServiceSize 

func PossibleValuesForServiceSize() []string

func PossibleValuesForServiceStatus 

func PossibleValuesForServiceStatus() []string

func PossibleValuesForServiceType 

func PossibleValuesForServiceType() []string

func ValidateDatabaseAccountID 

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

ValidateDatabaseAccountID checks that 'input' can be parsed as a Database Account ID

Types

type BaseServiceResourcePropertiesImpl added in v0.20240920.1135249 

type BaseServiceResourcePropertiesImpl struct {
	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	ServiceType   ServiceType    `json:"serviceType"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (BaseServiceResourcePropertiesImpl) ServiceResourceProperties added in v0.20240920.1135249 

func (s BaseServiceResourcePropertiesImpl) ServiceResourceProperties() BaseServiceResourcePropertiesImpl

type DataTransferServiceResourceProperties 

type DataTransferServiceResourceProperties struct {
	Locations *[]RegionalServiceResource `json:"locations,omitempty"`

	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	ServiceType   ServiceType    `json:"serviceType"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*DataTransferServiceResourceProperties) GetCreationTimeAsTime 

func (o *DataTransferServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (DataTransferServiceResourceProperties) MarshalJSON 

func (s DataTransferServiceResourceProperties) MarshalJSON() ([]byte, error)

func (DataTransferServiceResourceProperties) ServiceResourceProperties added in v0.20240920.1135249 

func (s DataTransferServiceResourceProperties) ServiceResourceProperties() BaseServiceResourcePropertiesImpl

func (*DataTransferServiceResourceProperties) SetCreationTimeAsTime 

func (o *DataTransferServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

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 DedicatedGatewayType 

type DedicatedGatewayType string
const (
	DedicatedGatewayTypeDistributedQuery DedicatedGatewayType = "DistributedQuery"
	DedicatedGatewayTypeIntegratedCache  DedicatedGatewayType = "IntegratedCache"
)

func (*DedicatedGatewayType) UnmarshalJSON 

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

type GraphAPIComputeRegionalServiceResource 

type GraphAPIComputeRegionalServiceResource struct {
	GraphApiComputeEndpoint *string        `json:"graphApiComputeEndpoint,omitempty"`
	Location                *string        `json:"location,omitempty"`
	Name                    *string        `json:"name,omitempty"`
	Status                  *ServiceStatus `json:"status,omitempty"`
}

type GraphAPIComputeServiceResourceProperties 

type GraphAPIComputeServiceResourceProperties struct {
	GraphApiComputeEndpoint *string                                   `json:"graphApiComputeEndpoint,omitempty"`
	Locations               *[]GraphAPIComputeRegionalServiceResource `json:"locations,omitempty"`

	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	ServiceType   ServiceType    `json:"serviceType"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*GraphAPIComputeServiceResourceProperties) GetCreationTimeAsTime 

func (o *GraphAPIComputeServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (GraphAPIComputeServiceResourceProperties) MarshalJSON 

func (s GraphAPIComputeServiceResourceProperties) MarshalJSON() ([]byte, error)

func (GraphAPIComputeServiceResourceProperties) ServiceResourceProperties added in v0.20240920.1135249 

func (s GraphAPIComputeServiceResourceProperties) ServiceResourceProperties() BaseServiceResourcePropertiesImpl

func (*GraphAPIComputeServiceResourceProperties) SetCreationTimeAsTime 

func (o *GraphAPIComputeServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

type MaterializedViewsBuilderServiceResourceProperties 

type MaterializedViewsBuilderServiceResourceProperties struct {
	Locations *[]RegionalServiceResource `json:"locations,omitempty"`

	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	ServiceType   ServiceType    `json:"serviceType"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*MaterializedViewsBuilderServiceResourceProperties) GetCreationTimeAsTime 

func (o *MaterializedViewsBuilderServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (MaterializedViewsBuilderServiceResourceProperties) MarshalJSON 

func (s MaterializedViewsBuilderServiceResourceProperties) MarshalJSON() ([]byte, error)

func (MaterializedViewsBuilderServiceResourceProperties) ServiceResourceProperties added in v0.20240920.1135249 

func (s MaterializedViewsBuilderServiceResourceProperties) ServiceResourceProperties() BaseServiceResourcePropertiesImpl

func (*MaterializedViewsBuilderServiceResourceProperties) SetCreationTimeAsTime 

func (o *MaterializedViewsBuilderServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

type RawServiceResourcePropertiesImpl 

type RawServiceResourcePropertiesImpl struct {
	Type   string
	Values map[string]interface{}
	// contains filtered or unexported fields
}

RawServiceResourcePropertiesImpl is returned when the Discriminated Value doesn't match any of the defined types NOTE: this should only be used when a type isn't defined for this type of Object (as a workaround) and is used only for Deserialization (e.g. this cannot be used as a Request Payload).

func (RawServiceResourcePropertiesImpl) ServiceResourceProperties added in v0.20240920.1135249 

func (s RawServiceResourcePropertiesImpl) ServiceResourceProperties() BaseServiceResourcePropertiesImpl

type RegionalServiceResource 

type RegionalServiceResource struct {
	Location *string        `json:"location,omitempty"`
	Name     *string        `json:"name,omitempty"`
	Status   *ServiceStatus `json:"status,omitempty"`
}

type ServiceListOperationResponse 

type ServiceListOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *ServiceResourceListResult
}

type ServiceResource 

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

func (*ServiceResource) UnmarshalJSON 

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

type ServiceResourceListResult 

type ServiceResourceListResult struct {
	Value *[]ServiceResource `json:"value,omitempty"`
}

type ServiceResourceProperties 

type ServiceResourceProperties interface {
	ServiceResourceProperties() BaseServiceResourcePropertiesImpl
}

func UnmarshalServiceResourcePropertiesImplementation added in v0.20240920.1135249 

func UnmarshalServiceResourcePropertiesImplementation(input []byte) (ServiceResourceProperties, error)

type ServiceSize 

type ServiceSize string
const (
	ServiceSizeCosmosPointDEights  ServiceSize = "Cosmos.D8s"
	ServiceSizeCosmosPointDFours   ServiceSize = "Cosmos.D4s"
	ServiceSizeCosmosPointDOneSixs ServiceSize = "Cosmos.D16s"
)

func (*ServiceSize) UnmarshalJSON 

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

type ServiceStatus 

type ServiceStatus string
const (
	ServiceStatusCreating ServiceStatus = "Creating"
	ServiceStatusDeleting ServiceStatus = "Deleting"
	ServiceStatusError    ServiceStatus = "Error"
	ServiceStatusRunning  ServiceStatus = "Running"
	ServiceStatusStopped  ServiceStatus = "Stopped"
	ServiceStatusUpdating ServiceStatus = "Updating"
)

func (*ServiceStatus) UnmarshalJSON 

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

type ServiceType 

type ServiceType string
const (
	ServiceTypeDataTransfer             ServiceType = "DataTransfer"
	ServiceTypeGraphAPICompute          ServiceType = "GraphAPICompute"
	ServiceTypeMaterializedViewsBuilder ServiceType = "MaterializedViewsBuilder"
	ServiceTypeSqlDedicatedGateway      ServiceType = "SqlDedicatedGateway"
)

func (*ServiceType) UnmarshalJSON 

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

type ServicesClient 

type ServicesClient struct {
	Client *resourcemanager.Client
}

func NewServicesClientWithBaseURI 

func NewServicesClientWithBaseURI(sdkApi sdkEnv.Api) (*ServicesClient, error)

func (ServicesClient) ServiceList 

func (c ServicesClient) ServiceList(ctx context.Context, id DatabaseAccountId) (result ServiceListOperationResponse, err error)

ServiceList ...

type SqlDedicatedGatewayRegionalServiceResource 

type SqlDedicatedGatewayRegionalServiceResource struct {
	Location                    *string        `json:"location,omitempty"`
	Name                        *string        `json:"name,omitempty"`
	SqlDedicatedGatewayEndpoint *string        `json:"sqlDedicatedGatewayEndpoint,omitempty"`
	Status                      *ServiceStatus `json:"status,omitempty"`
}

type SqlDedicatedGatewayServiceResourceProperties 

type SqlDedicatedGatewayServiceResourceProperties struct {
	DedicatedGatewayType        *DedicatedGatewayType                         `json:"dedicatedGatewayType,omitempty"`
	Locations                   *[]SqlDedicatedGatewayRegionalServiceResource `json:"locations,omitempty"`
	SqlDedicatedGatewayEndpoint *string                                       `json:"sqlDedicatedGatewayEndpoint,omitempty"`

	CreationTime  *string        `json:"creationTime,omitempty"`
	InstanceCount *int64         `json:"instanceCount,omitempty"`
	InstanceSize  *ServiceSize   `json:"instanceSize,omitempty"`
	ServiceType   ServiceType    `json:"serviceType"`
	Status        *ServiceStatus `json:"status,omitempty"`
}

func (*SqlDedicatedGatewayServiceResourceProperties) GetCreationTimeAsTime 

func (o *SqlDedicatedGatewayServiceResourceProperties) GetCreationTimeAsTime() (*time.Time, error)

func (SqlDedicatedGatewayServiceResourceProperties) MarshalJSON 

func (s SqlDedicatedGatewayServiceResourceProperties) MarshalJSON() ([]byte, error)

func (SqlDedicatedGatewayServiceResourceProperties) ServiceResourceProperties added in v0.20240920.1135249 

func (s SqlDedicatedGatewayServiceResourceProperties) ServiceResourceProperties() BaseServiceResourcePropertiesImpl

func (*SqlDedicatedGatewayServiceResourceProperties) SetCreationTimeAsTime 

func (o *SqlDedicatedGatewayServiceResourceProperties) SetCreationTimeAsTime(input time.Time)

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.