resourcegroups

Documentation

Overview

Copyright 2023 The Radius Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 The Radius Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 The Radius Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 The Radius Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func NewListResourceGroups(opts armrpc_controller.Options) (armrpc_controller.Controller, error)
• func NewListResources(opts armrpc_controller.Options) (armrpc_controller.Controller, error)
• func ValidateDownstream(ctx context.Context, client store.StorageClient, id resources.ID) (*url.URL, error)
• type InvalidError
  • func (e *InvalidError) Error() string
  • func (e *InvalidError) Is(err error) bool
• type ListResourceGroups
  • func (r *ListResourceGroups) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)
• type ListResources
  • func (r *ListResources) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)
• type NotFoundError
  • func (e *NotFoundError) Error() string
  • func (e *NotFoundError) Is(err error) bool

Constants

const (
	ResourceGroupType = "System.Resources/resourceGroups"
)

Functions

func NewListResourceGroups

func NewListResourceGroups(opts armrpc_controller.Options) (armrpc_controller.Controller, error)

NewListResourceGroups creates a new controller for listing resource groups.

func NewListResources

func NewListResources(opts armrpc_controller.Options) (armrpc_controller.Controller, error)

NewListResources creates a new controller for listing resources stored in a resource group.

func ValidateDownstream

func ValidateDownstream(ctx context.Context, client store.StorageClient, id resources.ID) (*url.URL, error)

ValidateDownstream can be used to find and validate the downstream URL for a resource. Returns NotFoundError for the case where the plane or resource group does not exist. Returns InvalidError for cases where the data is invalid, like when the resource provider is not configured.

Types

type InvalidError

type InvalidError struct {
	Message string
}

InvalidError is returned when the data is invalid.

func (*InvalidError) Error

func (e *InvalidError) Error() string

Error returns the error message.

func (*InvalidError) Is

func (e *InvalidError) Is(err error) bool

Is returns true if the error is a InvalidError.

type ListResourceGroups

type ListResourceGroups struct {
	armrpc_controller.Operation[*datamodel.ResourceGroup, datamodel.ResourceGroup]
}

ListResourceGroups is the controller implementation to get the list of UCP resource groups.

func (*ListResourceGroups) Run

func (r *ListResourceGroups) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)

Run() function extracts the plane type and name from the request URL, queries the storage client for resource groups in the scope of the plane, creates a response with the list of resource groups and returns an OK response with the list of resource groups.

type ListResources

type ListResources struct {
	armrpc_controller.Operation[*datamodel.GenericResource, datamodel.GenericResource]
}

ListResources is the controller implementation to get the list of resources stored in a resource group.

func (*ListResources) Run

func (r *ListResources) Run(ctx context.Context, w http.ResponseWriter, req *http.Request) (armrpc_rest.Response, error)

Run implements controller.Controller.

type NotFoundError

type NotFoundError struct {
	Message string
}

NotFoundError is returned when a resource group or plane is not found.

func (*NotFoundError) Error

func (e *NotFoundError) Error() string

Error returns the error message.

func (*NotFoundError) Is

func (e *NotFoundError) Is(err error) bool

Is returns true if the error is a NotFoundError.