resources

Documentation

Index

• type Deployment
• type DeploymentOutput
• type DeploymentProperties
• type GenericResource
• type ProviderManifest
• type ProviderResourceType
• type ResourceGroup
• type ResourceGroupProperties
• type ResourcesService
  • func New() *ResourcesService
  • func (s *ResourcesService) Actions() []service.Action
  • func (s *ResourcesService) HandleRequest(ctx *service.RequestContext) (*service.Response, error)
  • func (s *ResourcesService) HealthCheck() error
  • func (s *ResourcesService) Name() string
  • func (s *ResourcesService) ServiceKeys() []routing.ServiceKey
  • func (s *ResourcesService) SetTemplateProvisioner(provisioner TemplateProvisioner)
• type TagsProperties
• type TagsResource
• type TemplateListOperationProvider
• type TemplateProvisioner

Types

type Deployment

type Deployment struct {
	ID         string               `json:"id"`
	Name       string               `json:"name"`
	Type       string               `json:"type"`
	Properties DeploymentProperties `json:"properties"`
}

Deployment is the stored Azure Resource Manager deployment shape.

type DeploymentOutput

type DeploymentOutput struct {
	Type  string `json:"type"`
	Value any    `json:"value"`
}

type DeploymentProperties

type DeploymentProperties struct {
	ProvisioningState string                      `json:"provisioningState"`
	Mode              string                      `json:"mode"`
	Timestamp         string                      `json:"timestamp"`
	Parameters        map[string]any              `json:"parameters,omitempty"`
	Outputs           map[string]DeploymentOutput `json:"outputs,omitempty"`
	OutputResources   []any                       `json:"outputResources,omitempty"`
}

type GenericResource

type GenericResource struct {
	ID                string            `json:"id"`
	Name              string            `json:"name"`
	Type              string            `json:"type"`
	Location          string            `json:"location,omitempty"`
	Tags              map[string]string `json:"tags,omitempty"`
	Kind              string            `json:"kind,omitempty"`
	ManagedBy         string            `json:"managedBy,omitempty"`
	ExtendedLocation  map[string]any    `json:"extendedLocation,omitempty"`
	Identity          map[string]any    `json:"identity,omitempty"`
	Plan              map[string]any    `json:"plan,omitempty"`
	SKU               map[string]any    `json:"sku,omitempty"`
	Properties        map[string]any    `json:"properties,omitempty"`
	CreatedTime       string            `json:"createdTime,omitempty"`
	ChangedTime       string            `json:"changedTime,omitempty"`
	ProvisioningState string            `json:"provisioningState,omitempty"`
	// contains filtered or unexported fields
}

GenericResource is the shared ARM resource shape returned by the generic Microsoft.Resources resource APIs.

type ProviderManifest

type ProviderManifest struct {
	ID                 string                 `json:"id"`
	Namespace          string                 `json:"namespace"`
	RegistrationPolicy string                 `json:"registrationPolicy"`
	RegistrationState  string                 `json:"registrationState"`
	ResourceTypes      []ProviderResourceType `json:"resourceTypes"`
}

ProviderManifest describes an Azure resource provider namespace.

type ProviderResourceType

type ProviderResourceType struct {
	ResourceType string   `json:"resourceType"`
	Locations    []string `json:"locations,omitempty"`
	APIVersions  []string `json:"apiVersions"`
	Capabilities string   `json:"capabilities,omitempty"`
}

type ResourceGroup

type ResourceGroup struct {
	ID         string                  `json:"id"`
	Name       string                  `json:"name"`
	Type       string                  `json:"type"`
	Location   string                  `json:"location"`
	ManagedBy  string                  `json:"managedBy,omitempty"`
	Tags       map[string]string       `json:"tags,omitempty"`
	Properties ResourceGroupProperties `json:"properties"`
}

ResourceGroup is the Azure Resource Manager resource group shape.

type ResourceGroupProperties

type ResourceGroupProperties struct {
	ProvisioningState string `json:"provisioningState"`
}

type ResourcesService

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

ResourcesService implements the Azure Microsoft.Resources control-plane APIs.

func New

func New() *ResourcesService

New returns a Microsoft.Resources service backed by an in-memory store.

func (*ResourcesService) Actions

func (s *ResourcesService) Actions() []service.Action

func (*ResourcesService) HandleRequest

func (s *ResourcesService) HandleRequest(ctx *service.RequestContext) (*service.Response, error)

func (*ResourcesService) HealthCheck

func (s *ResourcesService) HealthCheck() error

func (*ResourcesService) Name

func (s *ResourcesService) Name() string

func (*ResourcesService) ServiceKeys

func (s *ResourcesService) ServiceKeys() []routing.ServiceKey

ServiceKeys returns the provider-aware registry keys handled by this service.

func (*ResourcesService) SetTemplateProvisioner

func (s *ResourcesService) SetTemplateProvisioner(provisioner TemplateProvisioner)

type TagsProperties

type TagsProperties struct {
	Tags map[string]string `json:"tags"`
}

type TagsResource

type TagsResource struct {
	ID         string         `json:"id"`
	Name       string         `json:"name"`
	Type       string         `json:"type"`
	Properties TagsProperties `json:"properties"`
}

TagsResource is the wrapper shape returned by the Azure tags-at-scope APIs.

type TemplateListOperationProvider

type TemplateListOperationProvider interface {
	TemplateListOperationResult(subscriptionID, resourceGroup string, resource map[string]any, operation string) (any, bool)
}

TemplateListOperationProvider optionally exposes ARM list* function results backed by a provisioner's runtime state.

type TemplateProvisioner

type TemplateProvisioner interface {
	SupportsTemplateResource(resource map[string]any) bool
	ProvisionTemplateResource(subscriptionID, resourceGroup string, resource map[string]any) (any, error)
}

TemplateProvisioner creates provider resources from resolved ARM template resources.