v20231001preview

package
v0.34.0 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const Version = "2023-10-01-preview"

Version represents the api version in this package.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionType 

type ActionType string

ActionType - Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. 

const (
	ActionTypeInternal ActionType = "Internal"
)

func PossibleActionTypeValues 

func PossibleActionTypeValues() []ActionType

PossibleActionTypeValues returns the possible values for the ActionType const type.

type ClientFactory 

type ClientFactory struct {
	// contains filtered or unexported fields
}

ClientFactory is a client factory used to create any client in this module. Don't use this type directly, use NewClientFactory instead.

func NewClientFactory 

func NewClientFactory(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ClientFactory, error)

NewClientFactory creates a new instance of ClientFactory with the specified values. The parameter values will be propagated to any client created from this factory.

  • rootScope - The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*ClientFactory) NewMongoDatabasesClient 

func (c *ClientFactory) NewMongoDatabasesClient() *MongoDatabasesClient

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

func (*ClientFactory) NewRedisCachesClient 

func (c *ClientFactory) NewRedisCachesClient() *RedisCachesClient

func (*ClientFactory) NewSQLDatabasesClient 

func (c *ClientFactory) NewSQLDatabasesClient() *SQLDatabasesClient

type CreatedByType 

type CreatedByType string

CreatedByType - The type of identity that created the resource. 

const (
	CreatedByTypeApplication     CreatedByType = "Application"
	CreatedByTypeKey             CreatedByType = "Key"
	CreatedByTypeManagedIdentity CreatedByType = "ManagedIdentity"
	CreatedByTypeUser            CreatedByType = "User"
)

func PossibleCreatedByTypeValues 

func PossibleCreatedByTypeValues() []CreatedByType

PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.

type EnvironmentCompute 

type EnvironmentCompute struct {
	// REQUIRED; Discriminator property for EnvironmentCompute.
	Kind *string

	// Configuration for supported external identity providers
	Identity *IdentitySettings

	// The resource id of the compute resource for application environment.
	ResourceID *string
}

EnvironmentCompute - Represents backing compute resource

func (*EnvironmentCompute) GetEnvironmentCompute 

func (e *EnvironmentCompute) GetEnvironmentCompute() *EnvironmentCompute

GetEnvironmentCompute implements the EnvironmentComputeClassification interface for type EnvironmentCompute.

func (EnvironmentCompute) MarshalJSON 

func (e EnvironmentCompute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type EnvironmentCompute.

func (*EnvironmentCompute) UnmarshalJSON 

func (e *EnvironmentCompute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentCompute.

type EnvironmentComputeClassification 

type EnvironmentComputeClassification interface {
	// GetEnvironmentCompute returns the EnvironmentCompute content of the underlying type.
	GetEnvironmentCompute() *EnvironmentCompute
}

EnvironmentComputeClassification provides polymorphic access to related types. Call the interface's GetEnvironmentCompute() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EnvironmentCompute, *KubernetesCompute

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info map[string]any

	// READ-ONLY; The additional info type.
	Type *string
}

ErrorAdditionalInfo - The resource management error additional info.

func (ErrorAdditionalInfo) MarshalJSON 

func (e ErrorAdditionalInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorAdditionalInfo.

func (*ErrorAdditionalInfo) UnmarshalJSON 

func (e *ErrorAdditionalInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorAdditionalInfo.

type ErrorDetail 

type ErrorDetail struct {
	// READ-ONLY; The error additional info.
	AdditionalInfo []*ErrorAdditionalInfo

	// READ-ONLY; The error code.
	Code *string

	// READ-ONLY; The error details.
	Details []*ErrorDetail

	// READ-ONLY; The error message.
	Message *string

	// READ-ONLY; The error target.
	Target *string
}

ErrorDetail - The error detail.

func (ErrorDetail) MarshalJSON 

func (e ErrorDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorDetail.

func (*ErrorDetail) UnmarshalJSON 

func (e *ErrorDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.

type ErrorResponse 

type ErrorResponse struct {
	// The error object.
	Error *ErrorDetail
}

ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

func (ErrorResponse) MarshalJSON 

func (e ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ErrorResponse.

func (*ErrorResponse) UnmarshalJSON 

func (e *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ErrorResponse.

type IdentitySettingKind 

type IdentitySettingKind string

IdentitySettingKind - IdentitySettingKind is the kind of supported external identity setting 

const (
	// IdentitySettingKindAzureComWorkload - azure ad workload identity
	IdentitySettingKindAzureComWorkload IdentitySettingKind = "azure.com.workload"
	// IdentitySettingKindUndefined - undefined identity
	IdentitySettingKindUndefined IdentitySettingKind = "undefined"
)

func PossibleIdentitySettingKindValues 

func PossibleIdentitySettingKindValues() []IdentitySettingKind

PossibleIdentitySettingKindValues returns the possible values for the IdentitySettingKind const type.

type IdentitySettings 

type IdentitySettings struct {
	// REQUIRED; kind of identity setting
	Kind *IdentitySettingKind

	// The URI for your compute platform's OIDC issuer
	OidcIssuer *string

	// The resource ID of the provisioned identity
	Resource *string
}

IdentitySettings is the external identity setting.

func (IdentitySettings) MarshalJSON 

func (i IdentitySettings) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type IdentitySettings.

func (*IdentitySettings) UnmarshalJSON 

func (i *IdentitySettings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type IdentitySettings.

type KubernetesCompute 

type KubernetesCompute struct {
	// REQUIRED; Discriminator property for EnvironmentCompute.
	Kind *string

	// REQUIRED; The namespace to use for the environment.
	Namespace *string

	// Configuration for supported external identity providers
	Identity *IdentitySettings

	// The resource id of the compute resource for application environment.
	ResourceID *string
}

KubernetesCompute - The Kubernetes compute configuration

func (*KubernetesCompute) GetEnvironmentCompute 

func (k *KubernetesCompute) GetEnvironmentCompute() *EnvironmentCompute

GetEnvironmentCompute implements the EnvironmentComputeClassification interface for type KubernetesCompute.

func (KubernetesCompute) MarshalJSON 

func (k KubernetesCompute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type KubernetesCompute.

func (*KubernetesCompute) UnmarshalJSON 

func (k *KubernetesCompute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesCompute.

type MongoDatabaseListSecretsResult 

type MongoDatabaseListSecretsResult struct {
	// Connection string used to connect to the target Mongo database
	ConnectionString *string

	// Password to use when connecting to the target Mongo database
	Password *string
}

MongoDatabaseListSecretsResult - The secret values for the given MongoDatabase resource

func (MongoDatabaseListSecretsResult) MarshalJSON 

func (m MongoDatabaseListSecretsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseListSecretsResult.

func (*MongoDatabaseListSecretsResult) UnmarshalJSON 

func (m *MongoDatabaseListSecretsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseListSecretsResult.

type MongoDatabaseProperties 

type MongoDatabaseProperties struct {
	// REQUIRED; Fully qualified resource ID for the environment that the portable resource is linked to
	Environment *string

	// Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
	Application *string

	// Database name of the target Mongo database
	Database *string

	// Host name of the target Mongo database
	Host *string

	// Port value of the target Mongo database
	Port *int32

	// The recipe used to automatically deploy underlying infrastructure for the resource
	Recipe *Recipe

	// Specifies how the underlying service/resource is provisioned and managed.
	ResourceProvisioning *ResourceProvisioning

	// List of the resource IDs that support the MongoDB resource
	Resources []*ResourceReference

	// Secret values provided for the resource
	Secrets *MongoDatabaseSecrets

	// Username to use when connecting to the target Mongo database
	Username *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState

	// READ-ONLY; Status of a resource.
	Status *ResourceStatus
}

MongoDatabaseProperties - MongoDatabase portable resource properties

func (MongoDatabaseProperties) MarshalJSON 

func (m MongoDatabaseProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseProperties.

func (*MongoDatabaseProperties) UnmarshalJSON 

func (m *MongoDatabaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseProperties.

type MongoDatabaseResource 

type MongoDatabaseResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *MongoDatabaseProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

MongoDatabaseResource - MongoDatabase portable resource

func (*MongoDatabaseResource) ConvertFrom 

func (dst *MongoDatabaseResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Mongo database resource. It returns an error if the DataModelInterface is not a Mongo database.

func (*MongoDatabaseResource) ConvertTo 

func (src *MongoDatabaseResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned Mongo database resource to version-agnostic datamodel and returns it, returning an error if any of the inputs are invalid.

func (MongoDatabaseResource) MarshalJSON 

func (m MongoDatabaseResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseResource.

func (*MongoDatabaseResource) UnmarshalJSON 

func (m *MongoDatabaseResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseResource.

type MongoDatabaseResourceListResult 

type MongoDatabaseResourceListResult struct {
	// REQUIRED; The MongoDatabaseResource items on this page
	Value []*MongoDatabaseResource

	// The link to the next page of items
	NextLink *string
}

MongoDatabaseResourceListResult - The response of a MongoDatabaseResource list operation.

func (MongoDatabaseResourceListResult) MarshalJSON 

func (m MongoDatabaseResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseResourceListResult.

func (*MongoDatabaseResourceListResult) UnmarshalJSON 

func (m *MongoDatabaseResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseResourceListResult.

type MongoDatabaseResourceUpdate 

type MongoDatabaseResourceUpdate struct {
	// The updatable properties of the MongoDatabaseResource.
	Properties *MongoDatabaseResourceUpdateProperties

	// Resource tags.
	Tags map[string]*string
}

MongoDatabaseResourceUpdate - The type used for update operations of the MongoDatabaseResource.

func (MongoDatabaseResourceUpdate) MarshalJSON 

func (m MongoDatabaseResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseResourceUpdate.

func (*MongoDatabaseResourceUpdate) UnmarshalJSON 

func (m *MongoDatabaseResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseResourceUpdate.

type MongoDatabaseResourceUpdateProperties 

type MongoDatabaseResourceUpdateProperties struct {
	// Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
	Application *string

	// Database name of the target Mongo database
	Database *string

	// Fully qualified resource ID for the environment that the portable resource is linked to
	Environment *string

	// Host name of the target Mongo database
	Host *string

	// Port value of the target Mongo database
	Port *int32

	// The recipe used to automatically deploy underlying infrastructure for the resource
	Recipe *RecipeUpdate

	// Specifies how the underlying service/resource is provisioned and managed.
	ResourceProvisioning *ResourceProvisioning

	// List of the resource IDs that support the MongoDB resource
	Resources []*ResourceReference

	// Secret values provided for the resource
	Secrets *MongoDatabaseSecrets

	// Username to use when connecting to the target Mongo database
	Username *string
}

MongoDatabaseResourceUpdateProperties - The updatable properties of the MongoDatabaseResource.

func (MongoDatabaseResourceUpdateProperties) MarshalJSON 

func (m MongoDatabaseResourceUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseResourceUpdateProperties.

func (*MongoDatabaseResourceUpdateProperties) UnmarshalJSON 

func (m *MongoDatabaseResourceUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseResourceUpdateProperties.

type MongoDatabaseSecrets 

type MongoDatabaseSecrets struct {
	// Connection string used to connect to the target Mongo database
	ConnectionString *string

	// Password to use when connecting to the target Mongo database
	Password *string
}

MongoDatabaseSecrets - The secret values for the given MongoDatabase resource

func (*MongoDatabaseSecrets) ConvertFrom 

func (dst *MongoDatabaseSecrets) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned MongoDatabaseSecrets instance and returns an error if the conversion fails.

func (*MongoDatabaseSecrets) ConvertTo 

func (src *MongoDatabaseSecrets) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned MongoDatabaseSecrets instance to version-agnostic datamodel.

func (MongoDatabaseSecrets) MarshalJSON 

func (m MongoDatabaseSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type MongoDatabaseSecrets.

func (*MongoDatabaseSecrets) UnmarshalJSON 

func (m *MongoDatabaseSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type MongoDatabaseSecrets.

type MongoDatabasesClient 

type MongoDatabasesClient struct {
	// contains filtered or unexported fields
}

MongoDatabasesClient contains the methods for the MongoDatabases group. Don't use this type directly, use NewMongoDatabasesClient() instead.

func NewMongoDatabasesClient 

func NewMongoDatabasesClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*MongoDatabasesClient, error)

NewMongoDatabasesClient creates a new instance of MongoDatabasesClient with the specified values.

  • rootScope - The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*MongoDatabasesClient) BeginCreateOrUpdate 

func (client *MongoDatabasesClient) BeginCreateOrUpdate(ctx context.Context, mongoDatabaseName string, resource MongoDatabaseResource, options *MongoDatabasesClientBeginCreateOrUpdateOptions) (*runtime.Poller[MongoDatabasesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a MongoDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • mongoDatabaseName - The name of the MongoDatabase portable resource resource
  • resource - Resource create parameters.
  • options - MongoDatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the MongoDatabasesClient.BeginCreateOrUpdate method.

func (*MongoDatabasesClient) BeginDelete 

func (client *MongoDatabasesClient) BeginDelete(ctx context.Context, mongoDatabaseName string, options *MongoDatabasesClientBeginDeleteOptions) (*runtime.Poller[MongoDatabasesClientDeleteResponse], error)

BeginDelete - Delete a MongoDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • mongoDatabaseName - The name of the MongoDatabase portable resource resource
  • options - MongoDatabasesClientBeginDeleteOptions contains the optional parameters for the MongoDatabasesClient.BeginDelete method.

func (*MongoDatabasesClient) BeginUpdate 

func (client *MongoDatabasesClient) BeginUpdate(ctx context.Context, mongoDatabaseName string, properties MongoDatabaseResourceUpdate, options *MongoDatabasesClientBeginUpdateOptions) (*runtime.Poller[MongoDatabasesClientUpdateResponse], error)

BeginUpdate - Update a MongoDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • mongoDatabaseName - The name of the MongoDatabase portable resource resource
  • properties - The resource properties to be updated.
  • options - MongoDatabasesClientBeginUpdateOptions contains the optional parameters for the MongoDatabasesClient.BeginUpdate method.

func (*MongoDatabasesClient) Get 

func (client *MongoDatabasesClient) Get(ctx context.Context, mongoDatabaseName string, options *MongoDatabasesClientGetOptions) (MongoDatabasesClientGetResponse, error)

Get - Get a MongoDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • mongoDatabaseName - The name of the MongoDatabase portable resource resource
  • options - MongoDatabasesClientGetOptions contains the optional parameters for the MongoDatabasesClient.Get method.

func (*MongoDatabasesClient) ListSecrets 

func (client *MongoDatabasesClient) ListSecrets(ctx context.Context, mongoDatabaseName string, body map[string]any, options *MongoDatabasesClientListSecretsOptions) (MongoDatabasesClientListSecretsResponse, error)

ListSecrets - Lists secrets values for the specified MongoDatabases resource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • mongoDatabaseName - The name of the MongoDatabase portable resource resource
  • body - The content of the action request
  • options - MongoDatabasesClientListSecretsOptions contains the optional parameters for the MongoDatabasesClient.ListSecrets method.

func (*MongoDatabasesClient) NewListByScopePager 

func (client *MongoDatabasesClient) NewListByScopePager(options *MongoDatabasesClientListByScopeOptions) *runtime.Pager[MongoDatabasesClientListByScopeResponse]

NewListByScopePager - List MongoDatabaseResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - MongoDatabasesClientListByScopeOptions contains the optional parameters for the MongoDatabasesClient.NewListByScopePager method.

type MongoDatabasesClientBeginCreateOrUpdateOptions 

type MongoDatabasesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MongoDatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the MongoDatabasesClient.BeginCreateOrUpdate method.

type MongoDatabasesClientBeginDeleteOptions 

type MongoDatabasesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MongoDatabasesClientBeginDeleteOptions contains the optional parameters for the MongoDatabasesClient.BeginDelete method.

type MongoDatabasesClientBeginUpdateOptions 

type MongoDatabasesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

MongoDatabasesClientBeginUpdateOptions contains the optional parameters for the MongoDatabasesClient.BeginUpdate method.

type MongoDatabasesClientCreateOrUpdateResponse 

type MongoDatabasesClientCreateOrUpdateResponse struct {
	// MongoDatabase portable resource
	MongoDatabaseResource
}

MongoDatabasesClientCreateOrUpdateResponse contains the response from method MongoDatabasesClient.BeginCreateOrUpdate.

type MongoDatabasesClientDeleteResponse 

type MongoDatabasesClientDeleteResponse struct {
}

MongoDatabasesClientDeleteResponse contains the response from method MongoDatabasesClient.BeginDelete.

type MongoDatabasesClientGetOptions 

type MongoDatabasesClientGetOptions struct {
}

MongoDatabasesClientGetOptions contains the optional parameters for the MongoDatabasesClient.Get method.

type MongoDatabasesClientGetResponse 

type MongoDatabasesClientGetResponse struct {
	// MongoDatabase portable resource
	MongoDatabaseResource
}

MongoDatabasesClientGetResponse contains the response from method MongoDatabasesClient.Get.

type MongoDatabasesClientListByScopeOptions 

type MongoDatabasesClientListByScopeOptions struct {
}

MongoDatabasesClientListByScopeOptions contains the optional parameters for the MongoDatabasesClient.NewListByScopePager method.

type MongoDatabasesClientListByScopeResponse 

type MongoDatabasesClientListByScopeResponse struct {
	// The response of a MongoDatabaseResource list operation.
	MongoDatabaseResourceListResult
}

MongoDatabasesClientListByScopeResponse contains the response from method MongoDatabasesClient.NewListByScopePager.

type MongoDatabasesClientListSecretsOptions 

type MongoDatabasesClientListSecretsOptions struct {
}

MongoDatabasesClientListSecretsOptions contains the optional parameters for the MongoDatabasesClient.ListSecrets method.

type MongoDatabasesClientListSecretsResponse 

type MongoDatabasesClientListSecretsResponse struct {
	// The secret values for the given MongoDatabase resource
	MongoDatabaseListSecretsResult
}

MongoDatabasesClientListSecretsResponse contains the response from method MongoDatabasesClient.ListSecrets.

type MongoDatabasesClientUpdateResponse 

type MongoDatabasesClientUpdateResponse struct {
	// MongoDatabase portable resource
	MongoDatabaseResource
}

MongoDatabasesClientUpdateResponse contains the response from method MongoDatabasesClient.BeginUpdate.

type Operation 

type Operation struct {
	// Localized display information for this particular operation.
	Display *OperationDisplay

	// READ-ONLY; Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
	ActionType *ActionType

	// READ-ONLY; Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane
	// operations.
	IsDataAction *bool

	// READ-ONLY; The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write",
	// "Microsoft.Compute/virtualMachines/capture/action"
	Name *string

	// READ-ONLY; The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default
	// value is "user,system"
	Origin *Origin
}

Operation - Details of a REST API operation, returned from the Resource Provider Operations API

func (Operation) MarshalJSON 

func (o Operation) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Operation.

func (*Operation) UnmarshalJSON 

func (o *Operation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Operation.

type OperationDisplay 

type OperationDisplay struct {
	// READ-ONLY; The short, localized friendly description of the operation; suitable for tool tips and detailed views.
	Description *string

	// READ-ONLY; The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual
	// Machine", "Restart Virtual Machine".
	Operation *string

	// READ-ONLY; The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft
	// Compute".
	Provider *string

	// READ-ONLY; The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job
	// Schedule Collections".
	Resource *string
}

OperationDisplay - Localized display information for this particular operation.

func (OperationDisplay) MarshalJSON 

func (o OperationDisplay) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationDisplay.

func (*OperationDisplay) UnmarshalJSON 

func (o *OperationDisplay) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationDisplay.

type OperationListResult 

type OperationListResult struct {
	// READ-ONLY; URL to get the next set of operation list results (if there are any).
	NextLink *string

	// READ-ONLY; List of operations supported by the resource provider
	Value []*Operation
}

OperationListResult - A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

func (OperationListResult) MarshalJSON 

func (o OperationListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OperationListResult.

func (*OperationListResult) UnmarshalJSON 

func (o *OperationListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OperationListResult.

type OperationsClient 

type OperationsClient struct {
	// contains filtered or unexported fields
}

OperationsClient contains the methods for the Operations group. Don't use this type directly, use NewOperationsClient() instead.

func NewOperationsClient 

func NewOperationsClient(credential azcore.TokenCredential, options *arm.ClientOptions) (*OperationsClient, error)

NewOperationsClient creates a new instance of OperationsClient with the specified values.

  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*OperationsClient) NewListPager 

func (client *OperationsClient) NewListPager(options *OperationsClientListOptions) *runtime.Pager[OperationsClientListResponse]

NewListPager - List the operations for the provider

Generated from API version 2023-10-01-preview

  • options - OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListOptions 

type OperationsClientListOptions struct {
}

OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.

type OperationsClientListResponse 

type OperationsClientListResponse struct {
	// A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
	OperationListResult
}

OperationsClientListResponse contains the response from method OperationsClient.NewListPager.

type Origin 

type Origin string

Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" 

const (
	OriginSystem     Origin = "system"
	OriginUser       Origin = "user"
	OriginUserSystem Origin = "user,system"
)

func PossibleOriginValues 

func PossibleOriginValues() []Origin

PossibleOriginValues returns the possible values for the Origin const type.

type OutputResource 

type OutputResource struct {
	// The UCP resource ID of the underlying resource.
	ID *string

	// The logical identifier scoped to the owning Radius resource. This is only needed or used when a resource has a dependency
	// relationship. LocalIDs do not have any particular format or meaning beyond
	// being compared to determine dependency relationships.
	LocalID *string

	// Determines whether Radius manages the lifecycle of the underlying resource.
	RadiusManaged *bool
}

OutputResource - Properties of an output resource.

func (OutputResource) MarshalJSON 

func (o OutputResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type OutputResource.

func (*OutputResource) UnmarshalJSON 

func (o *OutputResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type OutputResource.

type ProvisioningState 

type ProvisioningState string

ProvisioningState - Provisioning state of the resource at the time the operation was called 

const (
	// ProvisioningStateAccepted - The resource create request has been accepted
	ProvisioningStateAccepted ProvisioningState = "Accepted"
	// ProvisioningStateCanceled - Resource creation was canceled.
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateDeleting - The resource is being deleted
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed - Resource creation failed.
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateProvisioning - The resource is being provisioned
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	// ProvisioningStateSucceeded - Resource has been created.
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating - The resource is updating
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type Recipe 

type Recipe struct {
	// REQUIRED; The name of the recipe within the environment to use
	Name *string

	// Key/value parameters to pass into the recipe at deployment
	Parameters map[string]any
}

Recipe - The recipe used to automatically deploy underlying infrastructure for a portable resource

func (Recipe) MarshalJSON 

func (r Recipe) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Recipe.

func (*Recipe) UnmarshalJSON 

func (r *Recipe) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Recipe.

type RecipeStatus added in v0.27.0 

type RecipeStatus struct {
	// REQUIRED; TemplateKind is the kind of the recipe template used by the portable resource upon deployment.
	TemplateKind *string

	// REQUIRED; TemplatePath is the path of the recipe consumed by the portable resource upon deployment.
	TemplatePath *string

	// TemplateVersion is the version number of the template.
	TemplateVersion *string
}

RecipeStatus - Recipe status at deployment time for a resource.

func (RecipeStatus) MarshalJSON added in v0.27.0 

func (r RecipeStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipeStatus.

func (*RecipeStatus) UnmarshalJSON added in v0.27.0 

func (r *RecipeStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeStatus.

type RecipeUpdate 

type RecipeUpdate struct {
	// The name of the recipe within the environment to use
	Name *string

	// Key/value parameters to pass into the recipe at deployment
	Parameters map[string]any
}

RecipeUpdate - The recipe used to automatically deploy underlying infrastructure for a portable resource

func (RecipeUpdate) MarshalJSON 

func (r RecipeUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RecipeUpdate.

func (*RecipeUpdate) UnmarshalJSON 

func (r *RecipeUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeUpdate.

type RedisCacheListSecretsResult 

type RedisCacheListSecretsResult struct {
	// The connection string used to connect to the Redis cache
	ConnectionString *string

	// The password for this Redis cache instance
	Password *string

	// The URL used to connect to the Redis cache
	URL *string
}

RedisCacheListSecretsResult - The secret values for the given RedisCache resource

func (RedisCacheListSecretsResult) MarshalJSON 

func (r RedisCacheListSecretsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheListSecretsResult.

func (*RedisCacheListSecretsResult) UnmarshalJSON 

func (r *RedisCacheListSecretsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheListSecretsResult.

type RedisCacheProperties 

type RedisCacheProperties struct {
	// REQUIRED; Fully qualified resource ID for the environment that the portable resource is linked to
	Environment *string

	// Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
	Application *string

	// The host name of the target Redis cache
	Host *string

	// The port value of the target Redis cache
	Port *int32

	// The recipe used to automatically deploy underlying infrastructure for the resource
	Recipe *Recipe

	// Specifies how the underlying service/resource is provisioned and managed.
	ResourceProvisioning *ResourceProvisioning

	// List of the resource IDs that support the Redis resource
	Resources []*ResourceReference

	// Secrets provided by resource
	Secrets *RedisCacheSecrets

	// Specifies whether to enable SSL connections to the Redis cache
	TLS *bool

	// The username for Redis cache
	Username *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState

	// READ-ONLY; Status of a resource.
	Status *ResourceStatus
}

RedisCacheProperties - RedisCache portable resource properties

func (RedisCacheProperties) MarshalJSON 

func (r RedisCacheProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheProperties.

func (*RedisCacheProperties) UnmarshalJSON 

func (r *RedisCacheProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheProperties.

type RedisCacheResource 

type RedisCacheResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *RedisCacheProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

RedisCacheResource - RedisCache portable resource

func (*RedisCacheResource) ConvertFrom 

func (dst *RedisCacheResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Redis cache resource.

func (*RedisCacheResource) ConvertTo 

func (src *RedisCacheResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned Redis cache resource to version-agnostic datamodel and returns an error if the inputs are invalid.

func (RedisCacheResource) MarshalJSON 

func (r RedisCacheResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheResource.

func (*RedisCacheResource) UnmarshalJSON 

func (r *RedisCacheResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheResource.

type RedisCacheResourceListResult 

type RedisCacheResourceListResult struct {
	// REQUIRED; The RedisCacheResource items on this page
	Value []*RedisCacheResource

	// The link to the next page of items
	NextLink *string
}

RedisCacheResourceListResult - The response of a RedisCacheResource list operation.

func (RedisCacheResourceListResult) MarshalJSON 

func (r RedisCacheResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheResourceListResult.

func (*RedisCacheResourceListResult) UnmarshalJSON 

func (r *RedisCacheResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheResourceListResult.

type RedisCacheResourceUpdate 

type RedisCacheResourceUpdate struct {
	// The updatable properties of the RedisCacheResource.
	Properties *RedisCacheResourceUpdateProperties

	// Resource tags.
	Tags map[string]*string
}

RedisCacheResourceUpdate - The type used for update operations of the RedisCacheResource.

func (RedisCacheResourceUpdate) MarshalJSON 

func (r RedisCacheResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheResourceUpdate.

func (*RedisCacheResourceUpdate) UnmarshalJSON 

func (r *RedisCacheResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheResourceUpdate.

type RedisCacheResourceUpdateProperties 

type RedisCacheResourceUpdateProperties struct {
	// Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
	Application *string

	// Fully qualified resource ID for the environment that the portable resource is linked to
	Environment *string

	// The host name of the target Redis cache
	Host *string

	// The port value of the target Redis cache
	Port *int32

	// The recipe used to automatically deploy underlying infrastructure for the resource
	Recipe *RecipeUpdate

	// Specifies how the underlying service/resource is provisioned and managed.
	ResourceProvisioning *ResourceProvisioning

	// List of the resource IDs that support the Redis resource
	Resources []*ResourceReference

	// Secrets provided by resource
	Secrets *RedisCacheSecrets

	// Specifies whether to enable SSL connections to the Redis cache
	TLS *bool

	// The username for Redis cache
	Username *string
}

RedisCacheResourceUpdateProperties - The updatable properties of the RedisCacheResource.

func (RedisCacheResourceUpdateProperties) MarshalJSON 

func (r RedisCacheResourceUpdateProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheResourceUpdateProperties.

func (*RedisCacheResourceUpdateProperties) UnmarshalJSON 

func (r *RedisCacheResourceUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheResourceUpdateProperties.

type RedisCacheSecrets 

type RedisCacheSecrets struct {
	// The connection string used to connect to the Redis cache
	ConnectionString *string

	// The password for this Redis cache instance
	Password *string

	// The URL used to connect to the Redis cache
	URL *string
}

RedisCacheSecrets - The secret values for the given RedisCache resource

func (*RedisCacheSecrets) ConvertFrom 

func (dst *RedisCacheSecrets) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned Redis cacheSecrets instance and returns an error if the conversion fails.

func (*RedisCacheSecrets) ConvertTo 

func (src *RedisCacheSecrets) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned RedisCacheSecrets instance to version-agnostic datamodel.

func (RedisCacheSecrets) MarshalJSON 

func (r RedisCacheSecrets) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type RedisCacheSecrets.

func (*RedisCacheSecrets) UnmarshalJSON 

func (r *RedisCacheSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type RedisCacheSecrets.

type RedisCachesClient 

type RedisCachesClient struct {
	// contains filtered or unexported fields
}

RedisCachesClient contains the methods for the RedisCaches group. Don't use this type directly, use NewRedisCachesClient() instead.

func NewRedisCachesClient 

func NewRedisCachesClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RedisCachesClient, error)

NewRedisCachesClient creates a new instance of RedisCachesClient with the specified values.

  • rootScope - The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*RedisCachesClient) BeginCreateOrUpdate 

func (client *RedisCachesClient) BeginCreateOrUpdate(ctx context.Context, redisCacheName string, resource RedisCacheResource, options *RedisCachesClientBeginCreateOrUpdateOptions) (*runtime.Poller[RedisCachesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a RedisCacheResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • redisCacheName - The name of the RedisCache portable resource resource
  • resource - Resource create parameters.
  • options - RedisCachesClientBeginCreateOrUpdateOptions contains the optional parameters for the RedisCachesClient.BeginCreateOrUpdate method.

func (*RedisCachesClient) BeginDelete 

func (client *RedisCachesClient) BeginDelete(ctx context.Context, redisCacheName string, options *RedisCachesClientBeginDeleteOptions) (*runtime.Poller[RedisCachesClientDeleteResponse], error)

BeginDelete - Delete a RedisCacheResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • redisCacheName - The name of the RedisCache portable resource resource
  • options - RedisCachesClientBeginDeleteOptions contains the optional parameters for the RedisCachesClient.BeginDelete method.

func (*RedisCachesClient) BeginUpdate 

func (client *RedisCachesClient) BeginUpdate(ctx context.Context, redisCacheName string, properties RedisCacheResourceUpdate, options *RedisCachesClientBeginUpdateOptions) (*runtime.Poller[RedisCachesClientUpdateResponse], error)

BeginUpdate - Update a RedisCacheResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • redisCacheName - The name of the RedisCache portable resource resource
  • properties - The resource properties to be updated.
  • options - RedisCachesClientBeginUpdateOptions contains the optional parameters for the RedisCachesClient.BeginUpdate method.

func (*RedisCachesClient) Get 

func (client *RedisCachesClient) Get(ctx context.Context, redisCacheName string, options *RedisCachesClientGetOptions) (RedisCachesClientGetResponse, error)

Get - Get a RedisCacheResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • redisCacheName - The name of the RedisCache portable resource resource
  • options - RedisCachesClientGetOptions contains the optional parameters for the RedisCachesClient.Get method.

func (*RedisCachesClient) ListSecrets 

func (client *RedisCachesClient) ListSecrets(ctx context.Context, redisCacheName string, body map[string]any, options *RedisCachesClientListSecretsOptions) (RedisCachesClientListSecretsResponse, error)

ListSecrets - Lists secrets values for the specified RedisCache resource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • redisCacheName - The name of the RedisCache portable resource resource
  • body - The content of the action request
  • options - RedisCachesClientListSecretsOptions contains the optional parameters for the RedisCachesClient.ListSecrets method.

func (*RedisCachesClient) NewListByScopePager 

func (client *RedisCachesClient) NewListByScopePager(options *RedisCachesClientListByScopeOptions) *runtime.Pager[RedisCachesClientListByScopeResponse]

NewListByScopePager - List RedisCacheResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - RedisCachesClientListByScopeOptions contains the optional parameters for the RedisCachesClient.NewListByScopePager method.

type RedisCachesClientBeginCreateOrUpdateOptions 

type RedisCachesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RedisCachesClientBeginCreateOrUpdateOptions contains the optional parameters for the RedisCachesClient.BeginCreateOrUpdate method.

type RedisCachesClientBeginDeleteOptions 

type RedisCachesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RedisCachesClientBeginDeleteOptions contains the optional parameters for the RedisCachesClient.BeginDelete method.

type RedisCachesClientBeginUpdateOptions 

type RedisCachesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

RedisCachesClientBeginUpdateOptions contains the optional parameters for the RedisCachesClient.BeginUpdate method.

type RedisCachesClientCreateOrUpdateResponse 

type RedisCachesClientCreateOrUpdateResponse struct {
	// RedisCache portable resource
	RedisCacheResource
}

RedisCachesClientCreateOrUpdateResponse contains the response from method RedisCachesClient.BeginCreateOrUpdate.

type RedisCachesClientDeleteResponse 

type RedisCachesClientDeleteResponse struct {
}

RedisCachesClientDeleteResponse contains the response from method RedisCachesClient.BeginDelete.

type RedisCachesClientGetOptions 

type RedisCachesClientGetOptions struct {
}

RedisCachesClientGetOptions contains the optional parameters for the RedisCachesClient.Get method.

type RedisCachesClientGetResponse 

type RedisCachesClientGetResponse struct {
	// RedisCache portable resource
	RedisCacheResource
}

RedisCachesClientGetResponse contains the response from method RedisCachesClient.Get.

type RedisCachesClientListByScopeOptions 

type RedisCachesClientListByScopeOptions struct {
}

RedisCachesClientListByScopeOptions contains the optional parameters for the RedisCachesClient.NewListByScopePager method.

type RedisCachesClientListByScopeResponse 

type RedisCachesClientListByScopeResponse struct {
	// The response of a RedisCacheResource list operation.
	RedisCacheResourceListResult
}

RedisCachesClientListByScopeResponse contains the response from method RedisCachesClient.NewListByScopePager.

type RedisCachesClientListSecretsOptions 

type RedisCachesClientListSecretsOptions struct {
}

RedisCachesClientListSecretsOptions contains the optional parameters for the RedisCachesClient.ListSecrets method.

type RedisCachesClientListSecretsResponse 

type RedisCachesClientListSecretsResponse struct {
	// The secret values for the given RedisCache resource
	RedisCacheListSecretsResult
}

RedisCachesClientListSecretsResponse contains the response from method RedisCachesClient.ListSecrets.

type RedisCachesClientUpdateResponse 

type RedisCachesClientUpdateResponse struct {
	// RedisCache portable resource
	RedisCacheResource
}

RedisCachesClientUpdateResponse contains the response from method RedisCachesClient.BeginUpdate.

type Resource 

type Resource struct {
	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

Resource - Common fields that are returned in the response for all Azure Resource Manager resources

func (Resource) MarshalJSON 

func (r Resource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Resource.

func (*Resource) UnmarshalJSON 

func (r *Resource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Resource.

type ResourceProvisioning 

type ResourceProvisioning string

ResourceProvisioning - Specifies how the underlying service/resource is provisioned and managed. Available values are 'recipe', where Radius manages the lifecycle of the resource through a Recipe, and 'manual', where a user manages the resource and provides the values. 

const (
	// ResourceProvisioningManual - The resource lifecycle will be managed by the user
	ResourceProvisioningManual ResourceProvisioning = "manual"
	// ResourceProvisioningRecipe - The resource lifecycle will be managed by Radius
	ResourceProvisioningRecipe ResourceProvisioning = "recipe"
)

func PossibleResourceProvisioningValues 

func PossibleResourceProvisioningValues() []ResourceProvisioning

PossibleResourceProvisioningValues returns the possible values for the ResourceProvisioning const type.

type ResourceReference 

type ResourceReference struct {
	// REQUIRED; Resource id of an existing resource
	ID *string
}

ResourceReference - Describes a reference to an existing resource

func (ResourceReference) MarshalJSON 

func (r ResourceReference) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceReference.

func (*ResourceReference) UnmarshalJSON 

func (r *ResourceReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceReference.

type ResourceStatus 

type ResourceStatus struct {
	// The compute resource associated with the resource.
	Compute EnvironmentComputeClassification

	// Properties of an output resource
	OutputResources []*OutputResource

	// READ-ONLY; The recipe data at the time of deployment
	Recipe *RecipeStatus
}

ResourceStatus - Status of a resource.

func (ResourceStatus) MarshalJSON 

func (r ResourceStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ResourceStatus.

func (*ResourceStatus) UnmarshalJSON 

func (r *ResourceStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ResourceStatus.

type SQLDatabaseListSecretsResult 

type SQLDatabaseListSecretsResult struct {
	// Connection string used to connect to the target Sql database
	ConnectionString *string

	// Password to use when connecting to the target Sql database
	Password *string
}

SQLDatabaseListSecretsResult - The secret values for the given SqlDatabase resource

func (SQLDatabaseListSecretsResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseListSecretsResult.

func (*SQLDatabaseListSecretsResult) UnmarshalJSON 

func (s *SQLDatabaseListSecretsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseListSecretsResult.

type SQLDatabaseProperties 

type SQLDatabaseProperties struct {
	// REQUIRED; Fully qualified resource ID for the environment that the portable resource is linked to
	Environment *string

	// Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
	Application *string

	// The name of the Sql database.
	Database *string

	// Port value of the target Sql database
	Port *int32

	// The recipe used to automatically deploy underlying infrastructure for the resource
	Recipe *Recipe

	// Specifies how the underlying service/resource is provisioned and managed.
	ResourceProvisioning *ResourceProvisioning

	// List of the resource IDs that support the SqlDatabase resource
	Resources []*ResourceReference

	// Secret values provided for the resource
	Secrets *SQLDatabaseSecrets

	// The fully qualified domain name of the Sql database.
	Server *string

	// Username to use when connecting to the target Sql database
	Username *string

	// READ-ONLY; The status of the asynchronous operation.
	ProvisioningState *ProvisioningState

	// READ-ONLY; Status of a resource.
	Status *ResourceStatus
}

SQLDatabaseProperties - SqlDatabase properties

func (SQLDatabaseProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseProperties.

func (*SQLDatabaseProperties) UnmarshalJSON 

func (s *SQLDatabaseProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseProperties.

type SQLDatabaseResource 

type SQLDatabaseResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// REQUIRED; The resource-specific properties for this resource.
	Properties *SQLDatabaseProperties

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

SQLDatabaseResource - SqlDatabase portable resource

func (*SQLDatabaseResource) ConvertFrom 

func (dst *SQLDatabaseResource) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned SqlDatabase resource.

func (*SQLDatabaseResource) ConvertTo 

func (src *SQLDatabaseResource) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned SqlDatabase resource to version-agnostic datamodel and returns an error if the inputs are invalid.

func (SQLDatabaseResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseResource.

func (*SQLDatabaseResource) UnmarshalJSON 

func (s *SQLDatabaseResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseResource.

type SQLDatabaseResourceListResult 

type SQLDatabaseResourceListResult struct {
	// REQUIRED; The SqlDatabaseResource items on this page
	Value []*SQLDatabaseResource

	// The link to the next page of items
	NextLink *string
}

SQLDatabaseResourceListResult - The response of a SqlDatabaseResource list operation.

func (SQLDatabaseResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseResourceListResult.

func (*SQLDatabaseResourceListResult) UnmarshalJSON 

func (s *SQLDatabaseResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseResourceListResult.

type SQLDatabaseResourceUpdate 

type SQLDatabaseResourceUpdate struct {
	// The updatable properties of the SqlDatabaseResource.
	Properties *SQLDatabaseResourceUpdateProperties

	// Resource tags.
	Tags map[string]*string
}

SQLDatabaseResourceUpdate - The type used for update operations of the SqlDatabaseResource.

func (SQLDatabaseResourceUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseResourceUpdate.

func (*SQLDatabaseResourceUpdate) UnmarshalJSON 

func (s *SQLDatabaseResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseResourceUpdate.

type SQLDatabaseResourceUpdateProperties 

type SQLDatabaseResourceUpdateProperties struct {
	// Fully qualified resource ID for the application that the portable resource is consumed by (if applicable)
	Application *string

	// The name of the Sql database.
	Database *string

	// Fully qualified resource ID for the environment that the portable resource is linked to
	Environment *string

	// Port value of the target Sql database
	Port *int32

	// The recipe used to automatically deploy underlying infrastructure for the resource
	Recipe *RecipeUpdate

	// Specifies how the underlying service/resource is provisioned and managed.
	ResourceProvisioning *ResourceProvisioning

	// List of the resource IDs that support the SqlDatabase resource
	Resources []*ResourceReference

	// Secret values provided for the resource
	Secrets *SQLDatabaseSecrets

	// The fully qualified domain name of the Sql database.
	Server *string

	// Username to use when connecting to the target Sql database
	Username *string
}

SQLDatabaseResourceUpdateProperties - The updatable properties of the SqlDatabaseResource.

func (SQLDatabaseResourceUpdateProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseResourceUpdateProperties.

func (*SQLDatabaseResourceUpdateProperties) UnmarshalJSON 

func (s *SQLDatabaseResourceUpdateProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseResourceUpdateProperties.

type SQLDatabaseSecrets 

type SQLDatabaseSecrets struct {
	// Connection string used to connect to the target Sql database
	ConnectionString *string

	// Password to use when connecting to the target Sql database
	Password *string
}

SQLDatabaseSecrets - The secret values for the given SqlDatabase resource

func (*SQLDatabaseSecrets) ConvertFrom 

func (dst *SQLDatabaseSecrets) ConvertFrom(src v1.DataModelInterface) error

ConvertFrom converts from version-agnostic datamodel to the versioned SqlDatabaseSecrets instance and returns an error if the conversion fails.

func (*SQLDatabaseSecrets) ConvertTo 

func (src *SQLDatabaseSecrets) ConvertTo() (v1.DataModelInterface, error)

ConvertTo converts from the versioned SqlDatabaseSecrets instance to version-agnostic datamodel and returns an error if the conversion fails.

func (SQLDatabaseSecrets) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SQLDatabaseSecrets.

func (*SQLDatabaseSecrets) UnmarshalJSON 

func (s *SQLDatabaseSecrets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SQLDatabaseSecrets.

type SQLDatabasesClient 

type SQLDatabasesClient struct {
	// contains filtered or unexported fields
}

SQLDatabasesClient contains the methods for the SQLDatabases group. Don't use this type directly, use NewSQLDatabasesClient() instead.

func NewSQLDatabasesClient 

func NewSQLDatabasesClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SQLDatabasesClient, error)

NewSQLDatabasesClient creates a new instance of SQLDatabasesClient with the specified values.

  • rootScope - The scope in which the resource is present. UCP Scope is /planes/{planeType}/{planeName}/resourceGroup/{resourcegroupID} and Azure resource scope is /subscriptions/{subscriptionID}/resourceGroup/{resourcegroupID}
  • credential - used to authorize requests. Usually a credential from azidentity.
  • options - pass nil to accept the default values.

func (*SQLDatabasesClient) BeginCreateOrUpdate 

func (client *SQLDatabasesClient) BeginCreateOrUpdate(ctx context.Context, sqlDatabaseName string, resource SQLDatabaseResource, options *SQLDatabasesClientBeginCreateOrUpdateOptions) (*runtime.Poller[SQLDatabasesClientCreateOrUpdateResponse], error)

BeginCreateOrUpdate - Create a SqlDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • sqlDatabaseName - The name of the SqlDatabase portable resource resource
  • resource - Resource create parameters.
  • options - SQLDatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the SQLDatabasesClient.BeginCreateOrUpdate method.

func (*SQLDatabasesClient) BeginDelete 

func (client *SQLDatabasesClient) BeginDelete(ctx context.Context, sqlDatabaseName string, options *SQLDatabasesClientBeginDeleteOptions) (*runtime.Poller[SQLDatabasesClientDeleteResponse], error)

BeginDelete - Delete a SqlDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • sqlDatabaseName - The name of the SqlDatabase portable resource resource
  • options - SQLDatabasesClientBeginDeleteOptions contains the optional parameters for the SQLDatabasesClient.BeginDelete method.

func (*SQLDatabasesClient) BeginUpdate 

func (client *SQLDatabasesClient) BeginUpdate(ctx context.Context, sqlDatabaseName string, properties SQLDatabaseResourceUpdate, options *SQLDatabasesClientBeginUpdateOptions) (*runtime.Poller[SQLDatabasesClientUpdateResponse], error)

BeginUpdate - Update a SqlDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • sqlDatabaseName - The name of the SqlDatabase portable resource resource
  • properties - The resource properties to be updated.
  • options - SQLDatabasesClientBeginUpdateOptions contains the optional parameters for the SQLDatabasesClient.BeginUpdate method.

func (*SQLDatabasesClient) Get 

func (client *SQLDatabasesClient) Get(ctx context.Context, sqlDatabaseName string, options *SQLDatabasesClientGetOptions) (SQLDatabasesClientGetResponse, error)

Get - Get a SqlDatabaseResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • sqlDatabaseName - The name of the SqlDatabase portable resource resource
  • options - SQLDatabasesClientGetOptions contains the optional parameters for the SQLDatabasesClient.Get method.

func (*SQLDatabasesClient) ListSecrets 

func (client *SQLDatabasesClient) ListSecrets(ctx context.Context, sqlDatabaseName string, body map[string]any, options *SQLDatabasesClientListSecretsOptions) (SQLDatabasesClientListSecretsResponse, error)

ListSecrets - Lists secrets values for the specified SqlDatabase resource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • sqlDatabaseName - The name of the SqlDatabase portable resource resource
  • body - The content of the action request
  • options - SQLDatabasesClientListSecretsOptions contains the optional parameters for the SQLDatabasesClient.ListSecrets method.

func (*SQLDatabasesClient) NewListByScopePager 

func (client *SQLDatabasesClient) NewListByScopePager(options *SQLDatabasesClientListByScopeOptions) *runtime.Pager[SQLDatabasesClientListByScopeResponse]

NewListByScopePager - List SqlDatabaseResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - SQLDatabasesClientListByScopeOptions contains the optional parameters for the SQLDatabasesClient.NewListByScopePager method.

type SQLDatabasesClientBeginCreateOrUpdateOptions 

type SQLDatabasesClientBeginCreateOrUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLDatabasesClientBeginCreateOrUpdateOptions contains the optional parameters for the SQLDatabasesClient.BeginCreateOrUpdate method.

type SQLDatabasesClientBeginDeleteOptions 

type SQLDatabasesClientBeginDeleteOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLDatabasesClientBeginDeleteOptions contains the optional parameters for the SQLDatabasesClient.BeginDelete method.

type SQLDatabasesClientBeginUpdateOptions 

type SQLDatabasesClientBeginUpdateOptions struct {
	// Resumes the LRO from the provided token.
	ResumeToken string
}

SQLDatabasesClientBeginUpdateOptions contains the optional parameters for the SQLDatabasesClient.BeginUpdate method.

type SQLDatabasesClientCreateOrUpdateResponse 

type SQLDatabasesClientCreateOrUpdateResponse struct {
	// SqlDatabase portable resource
	SQLDatabaseResource
}

SQLDatabasesClientCreateOrUpdateResponse contains the response from method SQLDatabasesClient.BeginCreateOrUpdate.

type SQLDatabasesClientDeleteResponse 

type SQLDatabasesClientDeleteResponse struct {
}

SQLDatabasesClientDeleteResponse contains the response from method SQLDatabasesClient.BeginDelete.

type SQLDatabasesClientGetOptions 

type SQLDatabasesClientGetOptions struct {
}

SQLDatabasesClientGetOptions contains the optional parameters for the SQLDatabasesClient.Get method.

type SQLDatabasesClientGetResponse 

type SQLDatabasesClientGetResponse struct {
	// SqlDatabase portable resource
	SQLDatabaseResource
}

SQLDatabasesClientGetResponse contains the response from method SQLDatabasesClient.Get.

type SQLDatabasesClientListByScopeOptions 

type SQLDatabasesClientListByScopeOptions struct {
}

SQLDatabasesClientListByScopeOptions contains the optional parameters for the SQLDatabasesClient.NewListByScopePager method.

type SQLDatabasesClientListByScopeResponse 

type SQLDatabasesClientListByScopeResponse struct {
	// The response of a SqlDatabaseResource list operation.
	SQLDatabaseResourceListResult
}

SQLDatabasesClientListByScopeResponse contains the response from method SQLDatabasesClient.NewListByScopePager.

type SQLDatabasesClientListSecretsOptions 

type SQLDatabasesClientListSecretsOptions struct {
}

SQLDatabasesClientListSecretsOptions contains the optional parameters for the SQLDatabasesClient.ListSecrets method.

type SQLDatabasesClientListSecretsResponse 

type SQLDatabasesClientListSecretsResponse struct {
	// The secret values for the given SqlDatabase resource
	SQLDatabaseListSecretsResult
}

SQLDatabasesClientListSecretsResponse contains the response from method SQLDatabasesClient.ListSecrets.

type SQLDatabasesClientUpdateResponse 

type SQLDatabasesClientUpdateResponse struct {
	// SqlDatabase portable resource
	SQLDatabaseResource
}

SQLDatabasesClientUpdateResponse contains the response from method SQLDatabasesClient.BeginUpdate.

type SystemData 

type SystemData struct {
	// The timestamp of resource creation (UTC).
	CreatedAt *time.Time

	// The identity that created the resource.
	CreatedBy *string

	// The type of identity that created the resource.
	CreatedByType *CreatedByType

	// The timestamp of resource last modification (UTC)
	LastModifiedAt *time.Time

	// The identity that last modified the resource.
	LastModifiedBy *string

	// The type of identity that last modified the resource.
	LastModifiedByType *CreatedByType
}

SystemData - Metadata pertaining to creation and last modification of the resource.

func (SystemData) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SystemData.

func (*SystemData) UnmarshalJSON 

func (s *SystemData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SystemData.

type TrackedResource 

type TrackedResource struct {
	// REQUIRED; The geo-location where the resource lives
	Location *string

	// Resource tags.
	Tags map[string]*string

	// READ-ONLY; Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
	ID *string

	// READ-ONLY; The name of the resource
	Name *string

	// READ-ONLY; Azure Resource Manager metadata containing createdBy and modifiedBy information.
	SystemData *SystemData

	// READ-ONLY; The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
	Type *string
}

TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

func (TrackedResource) MarshalJSON 

func (t TrackedResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type TrackedResource.

func (*TrackedResource) UnmarshalJSON 

func (t *TrackedResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type TrackedResource.

type Versions 

type Versions string

Versions - Supported API versions for the Applications.Databases resource provider. 

const (
	// VersionsV20231001Preview - 2023-10-01-preview
	VersionsV20231001Preview Versions = "2023-10-01-preview"
)

func PossibleVersionsValues 

func PossibleVersionsValues() []Versions

PossibleVersionsValues returns the possible values for the Versions const type.

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.