v20231001preview

package
v0.36.0-rc1 Latest Latest
Warning

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

 Go to latest Published: Jul 18, 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) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

func (*ClientFactory) NewRabbitMqQueuesClient 

func (c *ClientFactory) NewRabbitMqQueuesClient() *RabbitMqQueuesClient

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 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 RabbitMQListSecretsResult 

type RabbitMQListSecretsResult struct {
	// The password used to connect to the RabbitMQ instance
	Password *string

	// The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost.
	// Can be overridden with a custom value
	URI *string
}

RabbitMQListSecretsResult - The secret values for the given RabbitMQQueue resource

func (RabbitMQListSecretsResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQListSecretsResult.

func (*RabbitMQListSecretsResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQListSecretsResult.

type RabbitMQQueueProperties 

type RabbitMQQueueProperties 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 hostname of the RabbitMQ instance
	Host *string

	// The port of the RabbitMQ instance. Defaults to 5672
	Port *int32

	// The name of the queue
	Queue *string

	// 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 rabbitMQ resource
	Resources []*ResourceReference

	// The secrets to connect to the RabbitMQ instance
	Secrets *RabbitMQSecrets

	// Specifies whether to use SSL when connecting to the RabbitMQ instance
	TLS *bool

	// The username to use when connecting to the RabbitMQ instance
	Username *string

	// The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost.
	VHost *string

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

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

RabbitMQQueueProperties - RabbitMQQueue portable resource properties

func (RabbitMQQueueProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQQueueProperties.

func (*RabbitMQQueueProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQQueueProperties.

type RabbitMQQueueResource 

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

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

	// 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
}

RabbitMQQueueResource - RabbitMQQueue portable resource

func (*RabbitMQQueueResource) ConvertFrom 

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

ConvertFrom converts a version-agnostic DataModelInterface to a versioned RabbitMQQueueResource, returning an error if the conversion fails.

func (*RabbitMQQueueResource) ConvertTo 

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

ConvertTo converts a versioned RabbitMQQueueResource to a version-agnostic datamodel.RabbitMQQueue and returns it or an error if the inputs are invalid.

func (RabbitMQQueueResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQQueueResource.

func (*RabbitMQQueueResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQQueueResource.

type RabbitMQQueueResourceListResult 

type RabbitMQQueueResourceListResult struct {
	// REQUIRED; The RabbitMQQueueResource items on this page
	Value []*RabbitMQQueueResource

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

RabbitMQQueueResourceListResult - The response of a RabbitMQQueueResource list operation.

func (RabbitMQQueueResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQQueueResourceListResult.

func (*RabbitMQQueueResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQQueueResourceListResult.

type RabbitMQQueueResourceUpdate 

type RabbitMQQueueResourceUpdate struct {
	// The updatable properties of the RabbitMQQueueResource.
	Properties *RabbitMQQueueResourceUpdateProperties

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

RabbitMQQueueResourceUpdate - The type used for update operations of the RabbitMQQueueResource.

func (RabbitMQQueueResourceUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQQueueResourceUpdate.

func (*RabbitMQQueueResourceUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQQueueResourceUpdate.

type RabbitMQQueueResourceUpdateProperties 

type RabbitMQQueueResourceUpdateProperties 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 hostname of the RabbitMQ instance
	Host *string

	// The port of the RabbitMQ instance. Defaults to 5672
	Port *int32

	// The name of the queue
	Queue *string

	// 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 rabbitMQ resource
	Resources []*ResourceReference

	// The secrets to connect to the RabbitMQ instance
	Secrets *RabbitMQSecrets

	// Specifies whether to use SSL when connecting to the RabbitMQ instance
	TLS *bool

	// The username to use when connecting to the RabbitMQ instance
	Username *string

	// The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost.
	VHost *string
}

RabbitMQQueueResourceUpdateProperties - The updatable properties of the RabbitMQQueueResource.

func (RabbitMQQueueResourceUpdateProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQQueueResourceUpdateProperties.

func (*RabbitMQQueueResourceUpdateProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQQueueResourceUpdateProperties.

type RabbitMQSecrets 

type RabbitMQSecrets struct {
	// The password used to connect to the RabbitMQ instance
	Password *string

	// The connection URI of the RabbitMQ instance. Generated automatically from host, port, SSL, username, password, and vhost.
	// Can be overridden with a custom value
	URI *string
}

RabbitMQSecrets - The connection secrets properties to the RabbitMQ instance

func (*RabbitMQSecrets) ConvertFrom 

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

ConvertFrom converts a version-agnostic datamodel.RabbitMQSecrets to a versioned RabbitMQSecrets, returning an error if the conversion fails.

func (*RabbitMQSecrets) ConvertTo 

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

ConvertTo converts a versioned RabbitMQSecrets object to a version-agnostic datamodel.RabbitMQSecrets object.

func (RabbitMQSecrets) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RabbitMQSecrets.

func (*RabbitMQSecrets) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RabbitMQSecrets.

type RabbitMqQueuesClient 

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

RabbitMqQueuesClient contains the methods for the RabbitMqQueues group. Don't use this type directly, use NewRabbitMqQueuesClient() instead.

func NewRabbitMqQueuesClient 

func NewRabbitMqQueuesClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RabbitMqQueuesClient, error)

NewRabbitMqQueuesClient creates a new instance of RabbitMqQueuesClient 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 (*RabbitMqQueuesClient) BeginCreateOrUpdate 

func (client *RabbitMqQueuesClient) BeginCreateOrUpdate(ctx context.Context, rabbitMQQueueName string, resource RabbitMQQueueResource, options *RabbitMqQueuesClientBeginCreateOrUpdateOptions) (*runtime.Poller[RabbitMqQueuesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • rabbitMQQueueName - The name of the RabbitMQQueue portable resource resource
  • resource - Resource create parameters.
  • options - RabbitMqQueuesClientBeginCreateOrUpdateOptions contains the optional parameters for the RabbitMqQueuesClient.BeginCreateOrUpdate method.

func (*RabbitMqQueuesClient) BeginDelete 

func (client *RabbitMqQueuesClient) BeginDelete(ctx context.Context, rabbitMQQueueName string, options *RabbitMqQueuesClientBeginDeleteOptions) (*runtime.Poller[RabbitMqQueuesClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • rabbitMQQueueName - The name of the RabbitMQQueue portable resource resource
  • options - RabbitMqQueuesClientBeginDeleteOptions contains the optional parameters for the RabbitMqQueuesClient.BeginDelete method.

func (*RabbitMqQueuesClient) BeginUpdate 

func (client *RabbitMqQueuesClient) BeginUpdate(ctx context.Context, rabbitMQQueueName string, properties RabbitMQQueueResourceUpdate, options *RabbitMqQueuesClientBeginUpdateOptions) (*runtime.Poller[RabbitMqQueuesClientUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • rabbitMQQueueName - The name of the RabbitMQQueue portable resource resource
  • properties - The resource properties to be updated.
  • options - RabbitMqQueuesClientBeginUpdateOptions contains the optional parameters for the RabbitMqQueuesClient.BeginUpdate method.

func (*RabbitMqQueuesClient) Get 

func (client *RabbitMqQueuesClient) Get(ctx context.Context, rabbitMQQueueName string, options *RabbitMqQueuesClientGetOptions) (RabbitMqQueuesClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • rabbitMQQueueName - The name of the RabbitMQQueue portable resource resource
  • options - RabbitMqQueuesClientGetOptions contains the optional parameters for the RabbitMqQueuesClient.Get method.

func (*RabbitMqQueuesClient) ListSecrets 

func (client *RabbitMqQueuesClient) ListSecrets(ctx context.Context, rabbitMQQueueName string, body map[string]any, options *RabbitMqQueuesClientListSecretsOptions) (RabbitMqQueuesClientListSecretsResponse, error)

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

Generated from API version 2023-10-01-preview

  • rabbitMQQueueName - The name of the RabbitMQQueue portable resource resource
  • body - The content of the action request
  • options - RabbitMqQueuesClientListSecretsOptions contains the optional parameters for the RabbitMqQueuesClient.ListSecrets method.

func (*RabbitMqQueuesClient) NewListByScopePager 

func (client *RabbitMqQueuesClient) NewListByScopePager(options *RabbitMqQueuesClientListByScopeOptions) *runtime.Pager[RabbitMqQueuesClientListByScopeResponse]

NewListByScopePager - List RabbitMQQueueResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - RabbitMqQueuesClientListByScopeOptions contains the optional parameters for the RabbitMqQueuesClient.NewListByScopePager method.

type RabbitMqQueuesClientBeginCreateOrUpdateOptions 

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

RabbitMqQueuesClientBeginCreateOrUpdateOptions contains the optional parameters for the RabbitMqQueuesClient.BeginCreateOrUpdate method.

type RabbitMqQueuesClientBeginDeleteOptions 

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

RabbitMqQueuesClientBeginDeleteOptions contains the optional parameters for the RabbitMqQueuesClient.BeginDelete method.

type RabbitMqQueuesClientBeginUpdateOptions 

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

RabbitMqQueuesClientBeginUpdateOptions contains the optional parameters for the RabbitMqQueuesClient.BeginUpdate method.

type RabbitMqQueuesClientCreateOrUpdateResponse 

type RabbitMqQueuesClientCreateOrUpdateResponse struct {
	// RabbitMQQueue portable resource
	RabbitMQQueueResource
}

RabbitMqQueuesClientCreateOrUpdateResponse contains the response from method RabbitMqQueuesClient.BeginCreateOrUpdate.

type RabbitMqQueuesClientDeleteResponse 

type RabbitMqQueuesClientDeleteResponse struct {
}

RabbitMqQueuesClientDeleteResponse contains the response from method RabbitMqQueuesClient.BeginDelete.

type RabbitMqQueuesClientGetOptions 

type RabbitMqQueuesClientGetOptions struct {
}

RabbitMqQueuesClientGetOptions contains the optional parameters for the RabbitMqQueuesClient.Get method.

type RabbitMqQueuesClientGetResponse 

type RabbitMqQueuesClientGetResponse struct {
	// RabbitMQQueue portable resource
	RabbitMQQueueResource
}

RabbitMqQueuesClientGetResponse contains the response from method RabbitMqQueuesClient.Get.

type RabbitMqQueuesClientListByScopeOptions 

type RabbitMqQueuesClientListByScopeOptions struct {
}

RabbitMqQueuesClientListByScopeOptions contains the optional parameters for the RabbitMqQueuesClient.NewListByScopePager method.

type RabbitMqQueuesClientListByScopeResponse 

type RabbitMqQueuesClientListByScopeResponse struct {
	// The response of a RabbitMQQueueResource list operation.
	RabbitMQQueueResourceListResult
}

RabbitMqQueuesClientListByScopeResponse contains the response from method RabbitMqQueuesClient.NewListByScopePager.

type RabbitMqQueuesClientListSecretsOptions 

type RabbitMqQueuesClientListSecretsOptions struct {
}

RabbitMqQueuesClientListSecretsOptions contains the optional parameters for the RabbitMqQueuesClient.ListSecrets method.

type RabbitMqQueuesClientListSecretsResponse 

type RabbitMqQueuesClientListSecretsResponse struct {
	// The secret values for the given RabbitMQQueue resource
	RabbitMQListSecretsResult
}

RabbitMqQueuesClientListSecretsResponse contains the response from method RabbitMqQueuesClient.ListSecrets.

type RabbitMqQueuesClientUpdateResponse 

type RabbitMqQueuesClientUpdateResponse struct {
	// RabbitMQQueue portable resource
	RabbitMQQueueResource
}

RabbitMqQueuesClientUpdateResponse contains the response from method RabbitMqQueuesClient.BeginUpdate.

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 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 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.Messaging 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.