v20250801preview

package
v0.57.0 Latest Latest
Warning

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

 Go to latest Published: Apr 23, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source 
const Version = "2025-08-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 ApplicationGraphConnection added in v0.53.0 

type ApplicationGraphConnection struct {
	// REQUIRED; The direction of the connection. 'Outbound' indicates this connection specifies the ID of the destination and
	// 'Inbound' indicates indicates this connection specifies the ID of the source.
	Direction *Direction

	// REQUIRED; The resource ID
	ID *string
}

ApplicationGraphConnection - Describes the connection between two resources.

func (ApplicationGraphConnection) MarshalJSON added in v0.53.0 

func (a ApplicationGraphConnection) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphConnection.

func (*ApplicationGraphConnection) UnmarshalJSON added in v0.53.0 

func (a *ApplicationGraphConnection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphConnection.

type ApplicationGraphOutputResource added in v0.53.0 

type ApplicationGraphOutputResource struct {
	// REQUIRED; The resource ID.
	ID *string

	// REQUIRED; The resource name.
	Name *string

	// REQUIRED; The resource type.
	Type *string
}

ApplicationGraphOutputResource - Describes an output resource that comprises an application graph resource.

func (ApplicationGraphOutputResource) MarshalJSON added in v0.53.0 

func (a ApplicationGraphOutputResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphOutputResource.

func (*ApplicationGraphOutputResource) UnmarshalJSON added in v0.53.0 

func (a *ApplicationGraphOutputResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphOutputResource.

type ApplicationGraphResource added in v0.53.0 

type ApplicationGraphResource struct {
	// REQUIRED; The connections between resources in the application graph.
	Connections []*ApplicationGraphConnection

	// REQUIRED; The resource ID.
	ID *string

	// REQUIRED; The resource name.
	Name *string

	// REQUIRED; The resources that comprise this resource.
	OutputResources []*ApplicationGraphOutputResource

	// REQUIRED; provisioningState of this resource.
	ProvisioningState *string

	// REQUIRED; The resource type.
	Type *string
}

ApplicationGraphResource - Describes a resource in the application graph.

func (ApplicationGraphResource) MarshalJSON added in v0.53.0 

func (a ApplicationGraphResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphResource.

func (*ApplicationGraphResource) UnmarshalJSON added in v0.53.0 

func (a *ApplicationGraphResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphResource.

type ApplicationGraphResponse added in v0.53.0 

type ApplicationGraphResponse struct {
	// REQUIRED; The resources in the application graph.
	Resources []*ApplicationGraphResource
}

ApplicationGraphResponse - Describes the application architecture and its dependencies.

func (ApplicationGraphResponse) MarshalJSON added in v0.53.0 

func (a ApplicationGraphResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphResponse.

func (*ApplicationGraphResponse) UnmarshalJSON added in v0.53.0 

func (a *ApplicationGraphResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphResponse.

type ApplicationProperties added in v0.53.0 

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

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

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

ApplicationProperties - Application properties

func (ApplicationProperties) MarshalJSON added in v0.53.0 

func (a ApplicationProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationProperties.

func (*ApplicationProperties) UnmarshalJSON added in v0.53.0 

func (a *ApplicationProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationProperties.

type ApplicationResource added in v0.53.0 

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

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

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

ApplicationResource - Radius Application resource

func (*ApplicationResource) ConvertFrom added in v0.53.0 

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

ConvertFrom converts from version-agnostic datamodel to the versioned ApplicationResource.

func (*ApplicationResource) ConvertTo added in v0.53.0 

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

ConvertTo converts from the versioned ApplicationResource to version-agnostic datamodel.

func (ApplicationResource) MarshalJSON added in v0.53.0 

func (a ApplicationResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationResource.

func (*ApplicationResource) UnmarshalJSON added in v0.53.0 

func (a *ApplicationResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationResource.

type ApplicationResourceListResult added in v0.53.0 

type ApplicationResourceListResult struct {
	// REQUIRED; The ApplicationResource items on this page
	Value []*ApplicationResource

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

ApplicationResourceListResult - The response of a ApplicationResource list operation.

func (ApplicationResourceListResult) MarshalJSON added in v0.53.0 

func (a ApplicationResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationResourceListResult.

func (*ApplicationResourceListResult) UnmarshalJSON added in v0.53.0 

func (a *ApplicationResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationResourceListResult.

type ApplicationResourceUpdate added in v0.53.0 

type ApplicationResourceUpdate struct {
	// 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
}

ApplicationResourceUpdate - Radius Application resource

func (ApplicationResourceUpdate) MarshalJSON added in v0.53.0 

func (a ApplicationResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ApplicationResourceUpdate.

func (*ApplicationResourceUpdate) UnmarshalJSON added in v0.53.0 

func (a *ApplicationResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationResourceUpdate.

type ApplicationsClient added in v0.53.0 

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

ApplicationsClient contains the methods for the Applications group. Don't use this type directly, use NewApplicationsClient() instead.

func NewApplicationsClient added in v0.53.0 

func NewApplicationsClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ApplicationsClient, error)

NewApplicationsClient creates a new instance of ApplicationsClient 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 - Contains optional client configuration. Pass nil to accept the default values.

func (*ApplicationsClient) CreateOrUpdate added in v0.53.0 

func (client *ApplicationsClient) CreateOrUpdate(ctx context.Context, applicationName string, resource ApplicationResource, options *ApplicationsClientCreateOrUpdateOptions) (ApplicationsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a ApplicationResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2025-08-01-preview

  • applicationName - The application name
  • resource - Resource create parameters.
  • options - ApplicationsClientCreateOrUpdateOptions contains the optional parameters for the ApplicationsClient.CreateOrUpdate method.

func (*ApplicationsClient) Delete added in v0.53.0 

func (client *ApplicationsClient) Delete(ctx context.Context, applicationName string, options *ApplicationsClientDeleteOptions) (ApplicationsClientDeleteResponse, error)

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

Generated from API version 2025-08-01-preview

  • applicationName - The application name
  • options - ApplicationsClientDeleteOptions contains the optional parameters for the ApplicationsClient.Delete method.

func (*ApplicationsClient) Get added in v0.53.0 

func (client *ApplicationsClient) Get(ctx context.Context, applicationName string, options *ApplicationsClientGetOptions) (ApplicationsClientGetResponse, error)

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

Generated from API version 2025-08-01-preview

  • applicationName - The application name
  • options - ApplicationsClientGetOptions contains the optional parameters for the ApplicationsClient.Get method.

func (*ApplicationsClient) GetGraph added in v0.53.0 

func (client *ApplicationsClient) GetGraph(ctx context.Context, applicationName string, body any, options *ApplicationsClientGetGraphOptions) (ApplicationsClientGetGraphResponse, error)

GetGraph - Gets the application graph and resources. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2025-08-01-preview

  • applicationName - The application name
  • body - The content of the action request
  • options - ApplicationsClientGetGraphOptions contains the optional parameters for the ApplicationsClient.GetGraph method.

func (*ApplicationsClient) NewListByScopePager added in v0.53.0 

func (client *ApplicationsClient) NewListByScopePager(options *ApplicationsClientListByScopeOptions) *runtime.Pager[ApplicationsClientListByScopeResponse]

NewListByScopePager - List ApplicationResource resources by Scope

Generated from API version 2025-08-01-preview

  • options - ApplicationsClientListByScopeOptions contains the optional parameters for the ApplicationsClient.NewListByScopePager method.

func (*ApplicationsClient) Update added in v0.53.0 

func (client *ApplicationsClient) Update(ctx context.Context, applicationName string, properties ApplicationResourceUpdate, options *ApplicationsClientUpdateOptions) (ApplicationsClientUpdateResponse, error)

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

Generated from API version 2025-08-01-preview

  • applicationName - The application name
  • properties - The resource properties to be updated.
  • options - ApplicationsClientUpdateOptions contains the optional parameters for the ApplicationsClient.Update method.

type ApplicationsClientCreateOrUpdateOptions added in v0.53.0 

type ApplicationsClientCreateOrUpdateOptions struct {
}

ApplicationsClientCreateOrUpdateOptions contains the optional parameters for the ApplicationsClient.CreateOrUpdate method.

type ApplicationsClientCreateOrUpdateResponse added in v0.53.0 

type ApplicationsClientCreateOrUpdateResponse struct {
	// Radius Application resource
	ApplicationResource
}

ApplicationsClientCreateOrUpdateResponse contains the response from method ApplicationsClient.CreateOrUpdate.

type ApplicationsClientDeleteOptions added in v0.53.0 

type ApplicationsClientDeleteOptions struct {
}

ApplicationsClientDeleteOptions contains the optional parameters for the ApplicationsClient.Delete method.

type ApplicationsClientDeleteResponse added in v0.53.0 

type ApplicationsClientDeleteResponse struct {
}

ApplicationsClientDeleteResponse contains the response from method ApplicationsClient.Delete.

type ApplicationsClientGetGraphOptions added in v0.53.0 

type ApplicationsClientGetGraphOptions struct {
}

ApplicationsClientGetGraphOptions contains the optional parameters for the ApplicationsClient.GetGraph method.

type ApplicationsClientGetGraphResponse added in v0.53.0 

type ApplicationsClientGetGraphResponse struct {
	// Describes the application architecture and its dependencies.
	ApplicationGraphResponse
}

ApplicationsClientGetGraphResponse contains the response from method ApplicationsClient.GetGraph.

type ApplicationsClientGetOptions added in v0.53.0 

type ApplicationsClientGetOptions struct {
}

ApplicationsClientGetOptions contains the optional parameters for the ApplicationsClient.Get method.

type ApplicationsClientGetResponse added in v0.53.0 

type ApplicationsClientGetResponse struct {
	// Radius Application resource
	ApplicationResource
}

ApplicationsClientGetResponse contains the response from method ApplicationsClient.Get.

type ApplicationsClientListByScopeOptions added in v0.53.0 

type ApplicationsClientListByScopeOptions struct {
}

ApplicationsClientListByScopeOptions contains the optional parameters for the ApplicationsClient.NewListByScopePager method.

type ApplicationsClientListByScopeResponse added in v0.53.0 

type ApplicationsClientListByScopeResponse struct {
	// The response of a ApplicationResource list operation.
	ApplicationResourceListResult
}

ApplicationsClientListByScopeResponse contains the response from method ApplicationsClient.NewListByScopePager.

type ApplicationsClientUpdateOptions added in v0.53.0 

type ApplicationsClientUpdateOptions struct {
}

ApplicationsClientUpdateOptions contains the optional parameters for the ApplicationsClient.Update method.

type ApplicationsClientUpdateResponse added in v0.53.0 

type ApplicationsClientUpdateResponse struct {
	// Radius Application resource
	ApplicationResource
}

ApplicationsClientUpdateResponse contains the response from method ApplicationsClient.Update.

type AzureContainerInstanceCompute added in v0.53.0 

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

	// Configuration for supported external identity providers
	Identity *IdentitySettings

	// The resource group to use for the environment.
	ResourceGroup *string

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

AzureContainerInstanceCompute - The Azure container instance compute configuration

func (*AzureContainerInstanceCompute) GetEnvironmentCompute added in v0.53.0 

func (a *AzureContainerInstanceCompute) GetEnvironmentCompute() *EnvironmentCompute

GetEnvironmentCompute implements the EnvironmentComputeClassification interface for type AzureContainerInstanceCompute.

func (AzureContainerInstanceCompute) MarshalJSON added in v0.53.0 

func (a AzureContainerInstanceCompute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureContainerInstanceCompute.

func (*AzureContainerInstanceCompute) UnmarshalJSON added in v0.53.0 

func (a *AzureContainerInstanceCompute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureContainerInstanceCompute.

type AzureResourceManagerCommonTypesTrackedResourceUpdate 

type AzureResourceManagerCommonTypesTrackedResourceUpdate struct {
	// 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
}

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

func (AzureResourceManagerCommonTypesTrackedResourceUpdate) MarshalJSON 

func (a AzureResourceManagerCommonTypesTrackedResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type AzureResourceManagerCommonTypesTrackedResourceUpdate.

func (*AzureResourceManagerCommonTypesTrackedResourceUpdate) UnmarshalJSON 

func (a *AzureResourceManagerCommonTypesTrackedResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type AzureResourceManagerCommonTypesTrackedResourceUpdate.

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) NewApplicationsClient added in v0.53.0 

func (c *ClientFactory) NewApplicationsClient() *ApplicationsClient

NewApplicationsClient creates a new instance of ApplicationsClient.

func (*ClientFactory) NewEnvironmentsClient 

func (c *ClientFactory) NewEnvironmentsClient() *EnvironmentsClient

NewEnvironmentsClient creates a new instance of EnvironmentsClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewRecipePacksClient added in v0.53.0 

func (c *ClientFactory) NewRecipePacksClient() *RecipePacksClient

NewRecipePacksClient creates a new instance of RecipePacksClient.

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 Direction added in v0.53.0 

type Direction string

Direction - The direction of a connection. 

const (
	// DirectionInbound - The resource defining this connection accepts inbound connections from the resource specified by this
	// id.
	DirectionInbound Direction = "Inbound"
	// DirectionOutbound - The resource defining this connection makes an outbound connection resource specified by this id.
	DirectionOutbound Direction = "Outbound"
)

func PossibleDirectionValues added in v0.53.0 

func PossibleDirectionValues() []Direction

PossibleDirectionValues returns the possible values for the Direction const type.

type EnvironmentCompute added in v0.53.0 

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 added in v0.53.0 

func (e *EnvironmentCompute) GetEnvironmentCompute() *EnvironmentCompute

GetEnvironmentCompute implements the EnvironmentComputeClassification interface for type EnvironmentCompute.

func (EnvironmentCompute) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentCompute.

func (*EnvironmentCompute) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentCompute.

type EnvironmentComputeClassification added in v0.53.0 

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: - *AzureContainerInstanceCompute, *EnvironmentCompute, *KubernetesCompute

type EnvironmentProperties 

type EnvironmentProperties struct {
	// Cloud provider configuration for the environment.
	Providers *Providers

	// List of Recipe Pack resource IDs linked to this environment.
	RecipePacks []*string

	// Recipe specific parameters that apply to all resources of a given type in this environment.
	RecipeParameters map[string]map[string]any

	// Simulated environment.
	Simulated *bool

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

EnvironmentProperties - Environment properties

func (EnvironmentProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentProperties.

func (*EnvironmentProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentProperties.

type EnvironmentResource 

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

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

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

EnvironmentResource - The environment resource

func (*EnvironmentResource) ConvertFrom 

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

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

func (*EnvironmentResource) ConvertTo 

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

ConvertTo converts from the versioned Environment resource to version-agnostic datamodel.

func (EnvironmentResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentResource.

func (*EnvironmentResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResource.

type EnvironmentResourceListResult 

type EnvironmentResourceListResult struct {
	// REQUIRED; The EnvironmentResource items on this page
	Value []*EnvironmentResource

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

EnvironmentResourceListResult - The response of a EnvironmentResource list operation.

func (EnvironmentResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentResourceListResult.

func (*EnvironmentResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResourceListResult.

type EnvironmentResourceUpdate 

type EnvironmentResourceUpdate struct {
	// 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
}

EnvironmentResourceUpdate - The environment resource

func (EnvironmentResourceUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentResourceUpdate.

func (*EnvironmentResourceUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentResourceUpdate.

type EnvironmentsClient 

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

EnvironmentsClient contains the methods for the Environments group. Don't use this type directly, use NewEnvironmentsClient() instead.

func NewEnvironmentsClient 

func NewEnvironmentsClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*EnvironmentsClient, error)

NewEnvironmentsClient creates a new instance of EnvironmentsClient 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 - Contains optional client configuration. Pass nil to accept the default values.

func (*EnvironmentsClient) CreateOrUpdate 

func (client *EnvironmentsClient) CreateOrUpdate(ctx context.Context, environmentName string, resource EnvironmentResource, options *EnvironmentsClientCreateOrUpdateOptions) (EnvironmentsClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a EnvironmentResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2025-08-01-preview

  • environmentName - environment name
  • resource - Resource create parameters.
  • options - EnvironmentsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.CreateOrUpdate method.

func (*EnvironmentsClient) Delete 

func (client *EnvironmentsClient) Delete(ctx context.Context, environmentName string, options *EnvironmentsClientDeleteOptions) (EnvironmentsClientDeleteResponse, error)

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

Generated from API version 2025-08-01-preview

  • environmentName - environment name
  • options - EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.

func (*EnvironmentsClient) Get 

func (client *EnvironmentsClient) Get(ctx context.Context, environmentName string, options *EnvironmentsClientGetOptions) (EnvironmentsClientGetResponse, error)

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

Generated from API version 2025-08-01-preview

  • environmentName - environment name
  • options - EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.

func (*EnvironmentsClient) NewListByScopePager 

func (client *EnvironmentsClient) NewListByScopePager(options *EnvironmentsClientListByScopeOptions) *runtime.Pager[EnvironmentsClientListByScopeResponse]

NewListByScopePager - List EnvironmentResource resources by Scope

Generated from API version 2025-08-01-preview

  • options - EnvironmentsClientListByScopeOptions contains the optional parameters for the EnvironmentsClient.NewListByScopePager method.

func (*EnvironmentsClient) Update 

func (client *EnvironmentsClient) Update(ctx context.Context, environmentName string, properties EnvironmentResourceUpdate, options *EnvironmentsClientUpdateOptions) (EnvironmentsClientUpdateResponse, error)

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

Generated from API version 2025-08-01-preview

  • environmentName - environment name
  • properties - The resource properties to be updated.
  • options - EnvironmentsClientUpdateOptions contains the optional parameters for the EnvironmentsClient.Update method.

type EnvironmentsClientCreateOrUpdateOptions 

type EnvironmentsClientCreateOrUpdateOptions struct {
}

EnvironmentsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.CreateOrUpdate method.

type EnvironmentsClientCreateOrUpdateResponse 

type EnvironmentsClientCreateOrUpdateResponse struct {
	// The environment resource
	EnvironmentResource
}

EnvironmentsClientCreateOrUpdateResponse contains the response from method EnvironmentsClient.CreateOrUpdate.

type EnvironmentsClientDeleteOptions 

type EnvironmentsClientDeleteOptions struct {
}

EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.

type EnvironmentsClientDeleteResponse 

type EnvironmentsClientDeleteResponse struct {
}

EnvironmentsClientDeleteResponse contains the response from method EnvironmentsClient.Delete.

type EnvironmentsClientGetOptions 

type EnvironmentsClientGetOptions struct {
}

EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.

type EnvironmentsClientGetResponse 

type EnvironmentsClientGetResponse struct {
	// The environment resource
	EnvironmentResource
}

EnvironmentsClientGetResponse contains the response from method EnvironmentsClient.Get.

type EnvironmentsClientListByScopeOptions 

type EnvironmentsClientListByScopeOptions struct {
}

EnvironmentsClientListByScopeOptions contains the optional parameters for the EnvironmentsClient.NewListByScopePager method.

type EnvironmentsClientListByScopeResponse 

type EnvironmentsClientListByScopeResponse struct {
	// The response of a EnvironmentResource list operation.
	EnvironmentResourceListResult
}

EnvironmentsClientListByScopeResponse contains the response from method EnvironmentsClient.NewListByScopePager.

type EnvironmentsClientUpdateOptions 

type EnvironmentsClientUpdateOptions struct {
}

EnvironmentsClientUpdateOptions contains the optional parameters for the EnvironmentsClient.Update method.

type EnvironmentsClientUpdateResponse 

type EnvironmentsClientUpdateResponse struct {
	// The environment resource
	EnvironmentResource
}

EnvironmentsClientUpdateResponse contains the response from method EnvironmentsClient.Update.

type ErrorAdditionalInfo 

type ErrorAdditionalInfo struct {
	// READ-ONLY; The additional info.
	Info 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"
	// IdentitySettingKindSystemAssigned - System assigned managed identity
	IdentitySettingKindSystemAssigned IdentitySettingKind = "systemAssigned"
	// IdentitySettingKindSystemAssignedUserAssigned - System assigned and user assigned managed identity
	IdentitySettingKindSystemAssignedUserAssigned IdentitySettingKind = "systemAssignedUserAssigned"
	// IdentitySettingKindUndefined - undefined identity
	IdentitySettingKindUndefined IdentitySettingKind = "undefined"
	// IdentitySettingKindUserAssigned - User assigned managed identity
	IdentitySettingKindUserAssigned IdentitySettingKind = "userAssigned"
)

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 list of user assigned managed identities
	ManagedIdentity []*string

	// 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 added in v0.53.0 

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 added in v0.53.0 

func (k *KubernetesCompute) GetEnvironmentCompute() *EnvironmentCompute

GetEnvironmentCompute implements the EnvironmentComputeClassification interface for type KubernetesCompute.

func (KubernetesCompute) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesCompute.

func (*KubernetesCompute) UnmarshalJSON added in v0.53.0 

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 - Contains optional client configuration. 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 2025-08-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 added in v0.53.0 

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 added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type OutputResource.

func (*OutputResource) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type OutputResource.

type Providers 

type Providers struct {
	// The AWS cloud provider configuration.
	Aws *ProvidersAws

	// The Azure cloud provider configuration.
	Azure *ProvidersAzure

	// The Kubernetes provider configuration.
	Kubernetes *ProvidersKubernetes
}

func (Providers) MarshalJSON 

func (p Providers) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Providers.

func (*Providers) UnmarshalJSON 

func (p *Providers) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Providers.

type ProvidersAws 

type ProvidersAws struct {
	// REQUIRED; AWS account ID for AWS resources to be deployed into.
	AccountID *string

	// REQUIRED; AWS region for AWS resources to be deployed into.
	Region *string
}

ProvidersAws - The AWS cloud provider definition.

func (ProvidersAws) MarshalJSON 

func (p ProvidersAws) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProvidersAws.

func (*ProvidersAws) UnmarshalJSON 

func (p *ProvidersAws) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProvidersAws.

type ProvidersAzure 

type ProvidersAzure struct {
	// REQUIRED; Azure subscription ID hosting deployed resources.
	SubscriptionID *string

	// External identity settings (moved from compute).
	Identity *IdentitySettings

	// Optional resource group name.
	ResourceGroupName *string
}

ProvidersAzure - The Azure cloud provider definition.

func (ProvidersAzure) MarshalJSON 

func (p ProvidersAzure) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProvidersAzure.

func (*ProvidersAzure) UnmarshalJSON 

func (p *ProvidersAzure) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProvidersAzure.

type ProvidersKubernetes 

type ProvidersKubernetes struct {
	// REQUIRED; Kubernetes namespace to deploy workloads into.
	Namespace *string
}

func (ProvidersKubernetes) MarshalJSON 

func (p ProvidersKubernetes) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ProvidersKubernetes.

func (*ProvidersKubernetes) UnmarshalJSON 

func (p *ProvidersKubernetes) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ProvidersKubernetes.

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 - The resource provisioning has been canceled
	ProvisioningStateCanceled ProvisioningState = "Canceled"
	// ProvisioningStateCreating - The resource is being created
	ProvisioningStateCreating ProvisioningState = "Creating"
	// ProvisioningStateDeleting - The resource is being deleted
	ProvisioningStateDeleting ProvisioningState = "Deleting"
	// ProvisioningStateFailed - The resource provisioning has failed
	ProvisioningStateFailed ProvisioningState = "Failed"
	// ProvisioningStateProvisioning - The resource is being provisioned
	ProvisioningStateProvisioning ProvisioningState = "Provisioning"
	// ProvisioningStateSucceeded - The resource has been successfully provisioned
	ProvisioningStateSucceeded ProvisioningState = "Succeeded"
	// ProvisioningStateUpdating - The resource is being updated
	ProvisioningStateUpdating ProvisioningState = "Updating"
)

func PossibleProvisioningStateValues 

func PossibleProvisioningStateValues() []ProvisioningState

PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.

type RecipeDefinition added in v0.53.0 

type RecipeDefinition struct {
	// REQUIRED; The type of recipe (e.g., Terraform, Bicep)
	RecipeKind *RecipeKind

	// REQUIRED; URL path to the recipe
	RecipeLocation *string

	// Parameters to pass to the recipe
	Parameters map[string]any

	// Connect to the location using HTTP (not HTTPS). This should be used when the location is known not to support HTTPS, for
	// example in a locally hosted registry for Bicep recipes. Defaults to false (use
	// HTTPS/TLS)
	PlainHTTP *bool
}

RecipeDefinition - Recipe definition for a specific resource type

func (RecipeDefinition) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipeDefinition.

func (*RecipeDefinition) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeDefinition.

type RecipeKind added in v0.53.0 

type RecipeKind string

RecipeKind - The type of recipe 

const (
	// RecipeKindBicep - Bicep recipe
	RecipeKindBicep RecipeKind = "bicep"
	// RecipeKindTerraform - Terraform recipe
	RecipeKindTerraform RecipeKind = "terraform"
)

func PossibleRecipeKindValues added in v0.53.0 

func PossibleRecipeKindValues() []RecipeKind

PossibleRecipeKindValues returns the possible values for the RecipeKind const type.

type RecipePackProperties added in v0.53.0 

type RecipePackProperties struct {
	// REQUIRED; Map of resource types to their recipe configurations
	Recipes map[string]*RecipeDefinition

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

	// READ-ONLY; List of environment IDs that reference this recipe pack
	ReferencedBy []*string
}

RecipePackProperties - Recipe Pack properties

func (RecipePackProperties) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipePackProperties.

func (*RecipePackProperties) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipePackProperties.

type RecipePackResource added in v0.53.0 

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

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

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

RecipePackResource - The recipe pack resource

func (*RecipePackResource) ConvertFrom added in v0.53.0 

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

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

func (*RecipePackResource) ConvertTo added in v0.53.0 

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

ConvertTo converts from the versioned RecipePack resource to version-agnostic datamodel.

func (RecipePackResource) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipePackResource.

func (*RecipePackResource) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipePackResource.

type RecipePackResourceListResult added in v0.53.0 

type RecipePackResourceListResult struct {
	// REQUIRED; The RecipePackResource items on this page
	Value []*RecipePackResource

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

RecipePackResourceListResult - The response of a RecipePackResource list operation.

func (RecipePackResourceListResult) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipePackResourceListResult.

func (*RecipePackResourceListResult) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipePackResourceListResult.

type RecipePackResourceUpdate added in v0.53.0 

type RecipePackResourceUpdate struct {
	// 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
}

RecipePackResourceUpdate - The recipe pack resource

func (RecipePackResourceUpdate) MarshalJSON added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipePackResourceUpdate.

func (*RecipePackResourceUpdate) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipePackResourceUpdate.

type RecipePacksClient added in v0.53.0 

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

RecipePacksClient contains the methods for the RecipePacks group. Don't use this type directly, use NewRecipePacksClient() instead.

func NewRecipePacksClient added in v0.53.0 

func NewRecipePacksClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*RecipePacksClient, error)

NewRecipePacksClient creates a new instance of RecipePacksClient 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 - Contains optional client configuration. Pass nil to accept the default values.

func (*RecipePacksClient) CreateOrUpdate added in v0.53.0 

func (client *RecipePacksClient) CreateOrUpdate(ctx context.Context, recipePackName string, resource RecipePackResource, options *RecipePacksClientCreateOrUpdateOptions) (RecipePacksClientCreateOrUpdateResponse, error)

CreateOrUpdate - Create a RecipePackResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2025-08-01-preview

  • recipePackName - Recipe pack name
  • resource - Resource create parameters.
  • options - RecipePacksClientCreateOrUpdateOptions contains the optional parameters for the RecipePacksClient.CreateOrUpdate method.

func (*RecipePacksClient) Delete added in v0.53.0 

func (client *RecipePacksClient) Delete(ctx context.Context, recipePackName string, options *RecipePacksClientDeleteOptions) (RecipePacksClientDeleteResponse, error)

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

Generated from API version 2025-08-01-preview

  • recipePackName - Recipe pack name
  • options - RecipePacksClientDeleteOptions contains the optional parameters for the RecipePacksClient.Delete method.

func (*RecipePacksClient) Get added in v0.53.0 

func (client *RecipePacksClient) Get(ctx context.Context, recipePackName string, options *RecipePacksClientGetOptions) (RecipePacksClientGetResponse, error)

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

Generated from API version 2025-08-01-preview

  • recipePackName - Recipe pack name
  • options - RecipePacksClientGetOptions contains the optional parameters for the RecipePacksClient.Get method.

func (*RecipePacksClient) NewListByScopePager added in v0.53.0 

func (client *RecipePacksClient) NewListByScopePager(options *RecipePacksClientListByScopeOptions) *runtime.Pager[RecipePacksClientListByScopeResponse]

NewListByScopePager - List RecipePackResource resources by Scope

Generated from API version 2025-08-01-preview

  • options - RecipePacksClientListByScopeOptions contains the optional parameters for the RecipePacksClient.NewListByScopePager method.

func (*RecipePacksClient) Update added in v0.53.0 

func (client *RecipePacksClient) Update(ctx context.Context, recipePackName string, properties RecipePackResourceUpdate, options *RecipePacksClientUpdateOptions) (RecipePacksClientUpdateResponse, error)

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

Generated from API version 2025-08-01-preview

  • recipePackName - Recipe pack name
  • properties - The resource properties to be updated.
  • options - RecipePacksClientUpdateOptions contains the optional parameters for the RecipePacksClient.Update method.

type RecipePacksClientCreateOrUpdateOptions added in v0.53.0 

type RecipePacksClientCreateOrUpdateOptions struct {
}

RecipePacksClientCreateOrUpdateOptions contains the optional parameters for the RecipePacksClient.CreateOrUpdate method.

type RecipePacksClientCreateOrUpdateResponse added in v0.53.0 

type RecipePacksClientCreateOrUpdateResponse struct {
	// The recipe pack resource
	RecipePackResource
}

RecipePacksClientCreateOrUpdateResponse contains the response from method RecipePacksClient.CreateOrUpdate.

type RecipePacksClientDeleteOptions added in v0.53.0 

type RecipePacksClientDeleteOptions struct {
}

RecipePacksClientDeleteOptions contains the optional parameters for the RecipePacksClient.Delete method.

type RecipePacksClientDeleteResponse added in v0.53.0 

type RecipePacksClientDeleteResponse struct {
}

RecipePacksClientDeleteResponse contains the response from method RecipePacksClient.Delete.

type RecipePacksClientGetOptions added in v0.53.0 

type RecipePacksClientGetOptions struct {
}

RecipePacksClientGetOptions contains the optional parameters for the RecipePacksClient.Get method.

type RecipePacksClientGetResponse added in v0.53.0 

type RecipePacksClientGetResponse struct {
	// The recipe pack resource
	RecipePackResource
}

RecipePacksClientGetResponse contains the response from method RecipePacksClient.Get.

type RecipePacksClientListByScopeOptions added in v0.53.0 

type RecipePacksClientListByScopeOptions struct {
}

RecipePacksClientListByScopeOptions contains the optional parameters for the RecipePacksClient.NewListByScopePager method.

type RecipePacksClientListByScopeResponse added in v0.53.0 

type RecipePacksClientListByScopeResponse struct {
	// The response of a RecipePackResource list operation.
	RecipePackResourceListResult
}

RecipePacksClientListByScopeResponse contains the response from method RecipePacksClient.NewListByScopePager.

type RecipePacksClientUpdateOptions added in v0.53.0 

type RecipePacksClientUpdateOptions struct {
}

RecipePacksClientUpdateOptions contains the optional parameters for the RecipePacksClient.Update method.

type RecipePacksClientUpdateResponse added in v0.53.0 

type RecipePacksClientUpdateResponse struct {
	// The recipe pack resource
	RecipePackResource
}

RecipePacksClientUpdateResponse contains the response from method RecipePacksClient.Update.

type RecipeStatus added in v0.53.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.53.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipeStatus.

func (*RecipeStatus) UnmarshalJSON added in v0.53.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeStatus.

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 ResourceStatus added in v0.53.0 

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 added in v0.53.0 

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

MarshalJSON implements the json.Marshaller interface for type ResourceStatus.

func (*ResourceStatus) UnmarshalJSON added in v0.53.0 

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.

Source Files

View all Source files

Directories

Path Synopsis

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.