v20231001preview

package
v0.41.0 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2024 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EnvironmentComputeKindKubernetes = "kubernetes"
)
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 ApplicationGraphConnection 

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 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphConnection.

func (*ApplicationGraphConnection) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphConnection.

type ApplicationGraphOutputResource 

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 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphOutputResource.

func (*ApplicationGraphOutputResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphOutputResource.

type ApplicationGraphResource 

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 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphResource.

func (*ApplicationGraphResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphResource.

type ApplicationGraphResponse 

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

ApplicationGraphResponse - Describes the application architecture and its dependencies.

func (ApplicationGraphResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationGraphResponse.

func (*ApplicationGraphResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationGraphResponse.

type ApplicationProperties 

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

	// The application extension.
	Extensions []ExtensionClassification

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

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

ApplicationProperties - Application properties

func (ApplicationProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationProperties.

func (*ApplicationProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationProperties.

type ApplicationResource 

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 

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

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

func (*ApplicationResource) ConvertTo 

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

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

func (ApplicationResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationResource.

func (*ApplicationResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationResource.

type ApplicationResourceListResult 

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 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationResourceListResult.

func (*ApplicationResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationResourceListResult.

type ApplicationResourceUpdate 

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 

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

MarshalJSON implements the json.Marshaller interface for type ApplicationResourceUpdate.

func (*ApplicationResourceUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationResourceUpdate.

type ApplicationsClient 

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 

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 - pass nil to accept the default values.

func (*ApplicationsClient) CreateOrUpdate 

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 2023-10-01-preview

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

func (*ApplicationsClient) Delete 

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 2023-10-01-preview

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

func (*ApplicationsClient) Get 

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 2023-10-01-preview

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

func (*ApplicationsClient) GetGraph 

func (client *ApplicationsClient) GetGraph(ctx context.Context, applicationName string, body map[string]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 2023-10-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 

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

NewListByScopePager - List ApplicationResource resources by Scope

Generated from API version 2023-10-01-preview

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

func (*ApplicationsClient) Update 

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 2023-10-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 

type ApplicationsClientCreateOrUpdateOptions struct {
}

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

type ApplicationsClientCreateOrUpdateResponse 

type ApplicationsClientCreateOrUpdateResponse struct {
	// Radius Application resource
	ApplicationResource
}

ApplicationsClientCreateOrUpdateResponse contains the response from method ApplicationsClient.CreateOrUpdate.

type ApplicationsClientDeleteOptions 

type ApplicationsClientDeleteOptions struct {
}

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

type ApplicationsClientDeleteResponse 

type ApplicationsClientDeleteResponse struct {
}

ApplicationsClientDeleteResponse contains the response from method ApplicationsClient.Delete.

type ApplicationsClientGetGraphOptions 

type ApplicationsClientGetGraphOptions struct {
}

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

type ApplicationsClientGetGraphResponse 

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

ApplicationsClientGetGraphResponse contains the response from method ApplicationsClient.GetGraph.

type ApplicationsClientGetOptions 

type ApplicationsClientGetOptions struct {
}

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

type ApplicationsClientGetResponse 

type ApplicationsClientGetResponse struct {
	// Radius Application resource
	ApplicationResource
}

ApplicationsClientGetResponse contains the response from method ApplicationsClient.Get.

type ApplicationsClientListByScopeOptions 

type ApplicationsClientListByScopeOptions struct {
}

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

type ApplicationsClientListByScopeResponse 

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

ApplicationsClientListByScopeResponse contains the response from method ApplicationsClient.NewListByScopePager.

type ApplicationsClientUpdateOptions 

type ApplicationsClientUpdateOptions struct {
}

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

type ApplicationsClientUpdateResponse 

type ApplicationsClientUpdateResponse struct {
	// Radius Application resource
	ApplicationResource
}

ApplicationsClientUpdateResponse contains the response from method ApplicationsClient.Update.

type AuthConfig added in v0.31.0 

type AuthConfig struct {
	// Authentication information used to access private Terraform modules from Git repository sources.
	Git *GitAuthConfig
}

AuthConfig - Authentication information used to access private Terraform module sources. Supported module sources: Git.

func (AuthConfig) MarshalJSON added in v0.31.0 

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

MarshalJSON implements the json.Marshaller interface for type AuthConfig.

func (*AuthConfig) UnmarshalJSON added in v0.31.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AuthConfig.

type AzureKeyVaultVolumeProperties 

type AzureKeyVaultVolumeProperties struct {
	// REQUIRED; Fully qualified resource ID for the application
	Application *string

	// REQUIRED; Discriminator property for VolumeProperties.
	Kind *string

	// REQUIRED; The ID of the keyvault to use for this volume resource
	Resource *string

	// The KeyVault certificates that this volume exposes
	Certificates map[string]*CertificateObjectProperties

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

	// The KeyVault keys that this volume exposes
	Keys map[string]*KeyObjectProperties

	// The KeyVault secrets that this volume exposes
	Secrets map[string]*SecretObjectProperties

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

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

AzureKeyVaultVolumeProperties - Represents Azure Key Vault Volume properties

func (*AzureKeyVaultVolumeProperties) GetVolumeProperties 

func (a *AzureKeyVaultVolumeProperties) GetVolumeProperties() *VolumeProperties

GetVolumeProperties implements the VolumePropertiesClassification interface for type AzureKeyVaultVolumeProperties.

func (AzureKeyVaultVolumeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type AzureKeyVaultVolumeProperties.

func (*AzureKeyVaultVolumeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureKeyVaultVolumeProperties.

type AzureResourceManagerCommonTypesTrackedResourceUpdate added in v0.40.0 

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

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

MarshalJSON implements the json.Marshaller interface for type AzureResourceManagerCommonTypesTrackedResourceUpdate.

func (*AzureResourceManagerCommonTypesTrackedResourceUpdate) UnmarshalJSON added in v0.40.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type AzureResourceManagerCommonTypesTrackedResourceUpdate.

type BicepConfigProperties added in v0.38.0 

type BicepConfigProperties struct {
	// Authentication information used to access private bicep registries, which is a map of registry hostname to secret config
	// that contains credential information.
	Authentication map[string]*RegistrySecretConfig
}

BicepConfigProperties - Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment.

func (BicepConfigProperties) MarshalJSON added in v0.38.0 

func (b BicepConfigProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BicepConfigProperties.

func (*BicepConfigProperties) UnmarshalJSON added in v0.38.0 

func (b *BicepConfigProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BicepConfigProperties.

type BicepRecipeProperties 

type BicepRecipeProperties struct {
	// REQUIRED; Discriminator property for RecipeProperties.
	TemplateKind *string

	// REQUIRED; Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
	TemplatePath *string

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

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

BicepRecipeProperties - Represents Bicep recipe properties.

func (*BicepRecipeProperties) GetRecipeProperties 

func (b *BicepRecipeProperties) GetRecipeProperties() *RecipeProperties

GetRecipeProperties implements the RecipePropertiesClassification interface for type BicepRecipeProperties.

func (BicepRecipeProperties) MarshalJSON 

func (b BicepRecipeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type BicepRecipeProperties.

func (*BicepRecipeProperties) UnmarshalJSON 

func (b *BicepRecipeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type BicepRecipeProperties.

type CertificateFormats 

type CertificateFormats string

CertificateFormats - Represents certificate formats 

const (
	// CertificateFormatsPem - PEM Certificate format
	CertificateFormatsPem CertificateFormats = "pem"
	// CertificateFormatsPfx - PFX Certificate format
	CertificateFormatsPfx CertificateFormats = "pfx"
)

func PossibleCertificateFormatsValues 

func PossibleCertificateFormatsValues() []CertificateFormats

PossibleCertificateFormatsValues returns the possible values for the CertificateFormats const type.

type CertificateObjectProperties 

type CertificateObjectProperties struct {
	// REQUIRED; The name of the certificate
	Name *string

	// File name when written to disk
	Alias *string

	// Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate
	CertType *CertificateTypes

	// Encoding format. Default utf-8
	Encoding *VolumeSecretEncodings

	// Certificate format. Default pem
	Format *CertificateFormats

	// Certificate version
	Version *string
}

CertificateObjectProperties - Represents certificate object properties

func (CertificateObjectProperties) MarshalJSON 

func (c CertificateObjectProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type CertificateObjectProperties.

func (*CertificateObjectProperties) UnmarshalJSON 

func (c *CertificateObjectProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type CertificateObjectProperties.

type CertificateTypes 

type CertificateTypes string

CertificateTypes - Represents certificate types 

const (
	// CertificateTypesCertificate - Certificate type
	CertificateTypesCertificate CertificateTypes = "certificate"
	// CertificateTypesPrivatekey - Private Key type
	CertificateTypesPrivatekey CertificateTypes = "privatekey"
	// CertificateTypesPublickey - Public Key type
	CertificateTypesPublickey CertificateTypes = "publickey"
)

func PossibleCertificateTypesValues 

func PossibleCertificateTypesValues() []CertificateTypes

PossibleCertificateTypesValues returns the possible values for the CertificateTypes 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) NewApplicationsClient 

func (c *ClientFactory) NewApplicationsClient() *ApplicationsClient

NewApplicationsClient creates a new instance of ApplicationsClient.

func (*ClientFactory) NewContainersClient 

func (c *ClientFactory) NewContainersClient() *ContainersClient

NewContainersClient creates a new instance of ContainersClient.

func (*ClientFactory) NewEnvironmentsClient 

func (c *ClientFactory) NewEnvironmentsClient() *EnvironmentsClient

NewEnvironmentsClient creates a new instance of EnvironmentsClient.

func (*ClientFactory) NewExtendersClient 

func (c *ClientFactory) NewExtendersClient() *ExtendersClient

NewExtendersClient creates a new instance of ExtendersClient.

func (*ClientFactory) NewGatewaysClient 

func (c *ClientFactory) NewGatewaysClient() *GatewaysClient

NewGatewaysClient creates a new instance of GatewaysClient.

func (*ClientFactory) NewOperationsClient 

func (c *ClientFactory) NewOperationsClient() *OperationsClient

NewOperationsClient creates a new instance of OperationsClient.

func (*ClientFactory) NewSecretStoresClient 

func (c *ClientFactory) NewSecretStoresClient() *SecretStoresClient

NewSecretStoresClient creates a new instance of SecretStoresClient.

func (*ClientFactory) NewVolumesClient 

func (c *ClientFactory) NewVolumesClient() *VolumesClient

NewVolumesClient creates a new instance of VolumesClient.

type ConnectionProperties 

type ConnectionProperties struct {
	// REQUIRED; The source of the connection
	Source *string

	// default environment variable override
	DisableDefaultEnvVars *bool

	// iam properties
	Iam *IamProperties
}

ConnectionProperties - Connection Properties

func (ConnectionProperties) MarshalJSON 

func (c ConnectionProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ConnectionProperties.

func (*ConnectionProperties) UnmarshalJSON 

func (c *ConnectionProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ConnectionProperties.

type Container 

type Container struct {
	// REQUIRED; The registry and image to download and run in your container
	Image *string

	// Arguments to the entrypoint. Overrides the container image's CMD
	Args []*string

	// Entrypoint array. Overrides the container image's ENTRYPOINT
	Command []*string

	// environment
	Env map[string]*EnvironmentVariable

	// The pull policy for the container image
	ImagePullPolicy *ImagePullPolicy

	// liveness probe properties
	LivenessProbe HealthProbePropertiesClassification

	// container ports
	Ports map[string]*ContainerPortProperties

	// readiness probe properties
	ReadinessProbe HealthProbePropertiesClassification

	// container volumes
	Volumes map[string]VolumeClassification

	// Working directory for the container
	WorkingDir *string
}

Container - Definition of a container

func (Container) MarshalJSON 

func (c Container) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Container.

func (*Container) UnmarshalJSON 

func (c *Container) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Container.

type ContainerPortProperties 

type ContainerPortProperties struct {
	// REQUIRED; The listening port number
	ContainerPort *int32

	// Specifies the port that will be exposed by this container. Must be set when value different from containerPort is desired
	Port *int32

	// Protocol in use by the port
	Protocol *PortProtocol

	// Specifies the URL scheme of the communication protocol. Consumers can use the scheme to construct a URL. The value defaults
	// to 'http' or 'https' depending on the port value
	Scheme *string
}

ContainerPortProperties - Specifies a listening port for the container

func (ContainerPortProperties) MarshalJSON 

func (c ContainerPortProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerPortProperties.

func (*ContainerPortProperties) UnmarshalJSON 

func (c *ContainerPortProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerPortProperties.

type ContainerProperties 

type ContainerProperties struct {
	// REQUIRED; Fully qualified resource ID for the application
	Application *string

	// REQUIRED; Definition of a container.
	Container *Container

	// Specifies a connection to another resource.
	Connections map[string]*ConnectionProperties

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

	// Extensions spec of the resource
	Extensions []ExtensionClassification

	// Configuration for supported external identity providers
	Identity *IdentitySettings

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

	// A collection of references to resources associated with the container
	Resources []*ResourceReference

	// The restart policy for the underlying container
	RestartPolicy *RestartPolicy

	// Specifies Runtime-specific functionality
	Runtimes *RuntimesProperties

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

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

ContainerProperties - Container properties

func (ContainerProperties) MarshalJSON 

func (c ContainerProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerProperties.

func (*ContainerProperties) UnmarshalJSON 

func (c *ContainerProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerProperties.

type ContainerResource 

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

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

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

ContainerResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (*ContainerResource) ConvertFrom 

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

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

func (*ContainerResource) ConvertTo 

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

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

func (ContainerResource) MarshalJSON 

func (c ContainerResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerResource.

func (*ContainerResource) UnmarshalJSON 

func (c *ContainerResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerResource.

type ContainerResourceListResult 

type ContainerResourceListResult struct {
	// REQUIRED; The ContainerResource items on this page
	Value []*ContainerResource

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

ContainerResourceListResult - The response of a ContainerResource list operation.

func (ContainerResourceListResult) MarshalJSON 

func (c ContainerResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerResourceListResult.

func (*ContainerResourceListResult) UnmarshalJSON 

func (c *ContainerResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerResourceListResult.

type ContainerResourceProvisioning 

type ContainerResourceProvisioning string

ContainerResourceProvisioning - Specifies how the underlying service/resource is provisioned and managed. Available values are 'internal', where Radius manages the lifecycle of the resource internally, and 'manual', where a user manages the resource. 

const (
	// ContainerResourceProvisioningInternal - The resource lifecycle will be managed internally by Radius
	ContainerResourceProvisioningInternal ContainerResourceProvisioning = "internal"
	// ContainerResourceProvisioningManual - The resource lifecycle will be managed by the user
	ContainerResourceProvisioningManual ContainerResourceProvisioning = "manual"
)

func PossibleContainerResourceProvisioningValues 

func PossibleContainerResourceProvisioningValues() []ContainerResourceProvisioning

PossibleContainerResourceProvisioningValues returns the possible values for the ContainerResourceProvisioning const type.

type ContainerResourceUpdate 

type ContainerResourceUpdate 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
}

ContainerResourceUpdate - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (ContainerResourceUpdate) MarshalJSON 

func (c ContainerResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ContainerResourceUpdate.

func (*ContainerResourceUpdate) UnmarshalJSON 

func (c *ContainerResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ContainerResourceUpdate.

type ContainersClient 

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

ContainersClient contains the methods for the Containers group. Don't use this type directly, use NewContainersClient() instead.

func NewContainersClient 

func NewContainersClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ContainersClient, error)

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

func (client *ContainersClient) BeginCreateOrUpdate(ctx context.Context, containerName string, resource ContainerResource, options *ContainersClientBeginCreateOrUpdateOptions) (*runtime.Poller[ContainersClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • containerName - Container name
  • resource - Resource create parameters.
  • options - ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.

func (*ContainersClient) BeginDelete 

func (client *ContainersClient) BeginDelete(ctx context.Context, containerName string, options *ContainersClientBeginDeleteOptions) (*runtime.Poller[ContainersClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • containerName - Container name
  • options - ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.

func (*ContainersClient) BeginUpdate 

func (client *ContainersClient) BeginUpdate(ctx context.Context, containerName string, properties ContainerResourceUpdate, options *ContainersClientBeginUpdateOptions) (*runtime.Poller[ContainersClientUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • containerName - Container name
  • properties - The resource properties to be updated.
  • options - ContainersClientBeginUpdateOptions contains the optional parameters for the ContainersClient.BeginUpdate method.

func (*ContainersClient) Get 

func (client *ContainersClient) Get(ctx context.Context, containerName string, options *ContainersClientGetOptions) (ContainersClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • containerName - Container name
  • options - ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.

func (*ContainersClient) NewListByScopePager 

func (client *ContainersClient) NewListByScopePager(options *ContainersClientListByScopeOptions) *runtime.Pager[ContainersClientListByScopeResponse]

NewListByScopePager - List ContainerResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - ContainersClientListByScopeOptions contains the optional parameters for the ContainersClient.NewListByScopePager method.

type ContainersClientBeginCreateOrUpdateOptions 

type ContainersClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.

type ContainersClientBeginDeleteOptions 

type ContainersClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.

type ContainersClientBeginUpdateOptions 

type ContainersClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ContainersClientBeginUpdateOptions contains the optional parameters for the ContainersClient.BeginUpdate method.

type ContainersClientCreateOrUpdateResponse 

type ContainersClientCreateOrUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	ContainerResource
}

ContainersClientCreateOrUpdateResponse contains the response from method ContainersClient.BeginCreateOrUpdate.

type ContainersClientDeleteResponse 

type ContainersClientDeleteResponse struct {
}

ContainersClientDeleteResponse contains the response from method ContainersClient.BeginDelete.

type ContainersClientGetOptions 

type ContainersClientGetOptions struct {
}

ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.

type ContainersClientGetResponse 

type ContainersClientGetResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	ContainerResource
}

ContainersClientGetResponse contains the response from method ContainersClient.Get.

type ContainersClientListByScopeOptions 

type ContainersClientListByScopeOptions struct {
}

ContainersClientListByScopeOptions contains the optional parameters for the ContainersClient.NewListByScopePager method.

type ContainersClientListByScopeResponse 

type ContainersClientListByScopeResponse struct {
	// The response of a ContainerResource list operation.
	ContainerResourceListResult
}

ContainersClientListByScopeResponse contains the response from method ContainersClient.NewListByScopePager.

type ContainersClientUpdateResponse 

type ContainersClientUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	ContainerResource
}

ContainersClientUpdateResponse contains the response from method ContainersClient.BeginUpdate.

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 DaprSidecarExtension 

type DaprSidecarExtension struct {
	// REQUIRED; The Dapr appId. Specifies the identifier used by Dapr for service invocation.
	AppID *string

	// REQUIRED; Discriminator property for Extension.
	Kind *string

	// The Dapr appPort. Specifies the internal listening port for the application to handle requests from the Dapr sidecar.
	AppPort *int32

	// Specifies the Dapr configuration to use for the resource.
	Config *string

	// Specifies the Dapr app-protocol to use for the resource.
	Protocol *DaprSidecarExtensionProtocol
}

DaprSidecarExtension - Specifies the resource should have a Dapr sidecar injected

func (*DaprSidecarExtension) GetExtension 

func (d *DaprSidecarExtension) GetExtension() *Extension

GetExtension implements the ExtensionClassification interface for type DaprSidecarExtension.

func (DaprSidecarExtension) MarshalJSON 

func (d DaprSidecarExtension) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type DaprSidecarExtension.

func (*DaprSidecarExtension) UnmarshalJSON 

func (d *DaprSidecarExtension) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type DaprSidecarExtension.

type DaprSidecarExtensionProtocol 

type DaprSidecarExtensionProtocol string

DaprSidecarExtensionProtocol - The Dapr sidecar extension protocol 

const (
	// DaprSidecarExtensionProtocolGrpc - gRPC protocol
	DaprSidecarExtensionProtocolGrpc DaprSidecarExtensionProtocol = "grpc"
	// DaprSidecarExtensionProtocolHTTP - HTTP protocol
	DaprSidecarExtensionProtocolHTTP DaprSidecarExtensionProtocol = "http"
)

func PossibleDaprSidecarExtensionProtocolValues 

func PossibleDaprSidecarExtensionProtocolValues() []DaprSidecarExtensionProtocol

PossibleDaprSidecarExtensionProtocolValues returns the possible values for the DaprSidecarExtensionProtocol const type.

type Direction 

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 

func PossibleDirectionValues() []Direction

PossibleDirectionValues returns the possible values for the Direction 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 EnvironmentProperties 

type EnvironmentProperties struct {
	// REQUIRED; The compute resource used by application environment.
	Compute EnvironmentComputeClassification

	// The environment extension.
	Extensions []ExtensionClassification

	// Cloud providers configuration for the environment.
	Providers *Providers

	// Configuration for Recipes. Defines how each type of Recipe should be configured and run.
	RecipeConfig *RecipeConfigProperties

	// Specifies Recipes linked to the Environment.
	Recipes map[string]map[string]RecipePropertiesClassification

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

type EnvironmentVariable struct {
	// The value of the environment variable
	Value *string

	// The reference to the variable
	ValueFrom *EnvironmentVariableReference
}

EnvironmentVariable - Environment variables type

func (EnvironmentVariable) MarshalJSON added in v0.38.0 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentVariable.

func (*EnvironmentVariable) UnmarshalJSON added in v0.38.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVariable.

type EnvironmentVariableReference added in v0.38.0 

type EnvironmentVariableReference struct {
	// REQUIRED; The secret reference
	SecretRef *SecretReference
}

EnvironmentVariableReference - The reference to the variable

func (EnvironmentVariableReference) MarshalJSON added in v0.38.0 

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

MarshalJSON implements the json.Marshaller interface for type EnvironmentVariableReference.

func (*EnvironmentVariableReference) UnmarshalJSON added in v0.38.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentVariableReference.

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 - 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 2023-10-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 2023-10-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 2023-10-01-preview

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

func (*EnvironmentsClient) GetMetadata 

func (client *EnvironmentsClient) GetMetadata(ctx context.Context, environmentName string, body RecipeGetMetadata, options *EnvironmentsClientGetMetadataOptions) (EnvironmentsClientGetMetadataResponse, error)

GetMetadata - Gets recipe metadata including parameters and any constraints on the parameters. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • environmentName - environment name
  • body - The content of the action request
  • options - EnvironmentsClientGetMetadataOptions contains the optional parameters for the EnvironmentsClient.GetMetadata method.

func (*EnvironmentsClient) NewListByScopePager 

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

NewListByScopePager - List EnvironmentResource resources by Scope

Generated from API version 2023-10-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 2023-10-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 EnvironmentsClientGetMetadataOptions 

type EnvironmentsClientGetMetadataOptions struct {
}

EnvironmentsClientGetMetadataOptions contains the optional parameters for the EnvironmentsClient.GetMetadata method.

type EnvironmentsClientGetMetadataResponse 

type EnvironmentsClientGetMetadataResponse struct {
	// The properties of a Recipe linked to an Environment.
	RecipeGetMetadataResponse
}

EnvironmentsClientGetMetadataResponse contains the response from method EnvironmentsClient.GetMetadata.

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 EphemeralVolume 

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

	// REQUIRED; Backing store for the ephemeral volume
	ManagedStore *ManagedStore

	// The path where the volume is mounted
	MountPath *string
}

EphemeralVolume - Specifies an ephemeral volume for a container

func (*EphemeralVolume) GetVolume 

func (e *EphemeralVolume) GetVolume() *Volume

GetVolume implements the VolumeClassification interface for type EphemeralVolume.

func (EphemeralVolume) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type EphemeralVolume.

func (*EphemeralVolume) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type EphemeralVolume.

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 ExecHealthProbeProperties 

type ExecHealthProbeProperties struct {
	// REQUIRED; Command to execute to probe readiness/liveness
	Command *string

	// REQUIRED; Discriminator property for HealthProbeProperties.
	Kind *string

	// Threshold number of times the probe fails after which a failure would be reported
	FailureThreshold *float32

	// Initial delay in seconds before probing for readiness/liveness
	InitialDelaySeconds *float32

	// Interval for the readiness/liveness probe in seconds
	PeriodSeconds *float32

	// Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds
	TimeoutSeconds *float32
}

ExecHealthProbeProperties - Specifies the properties for readiness/liveness probe using an executable

func (*ExecHealthProbeProperties) GetHealthProbeProperties 

func (e *ExecHealthProbeProperties) GetHealthProbeProperties() *HealthProbeProperties

GetHealthProbeProperties implements the HealthProbePropertiesClassification interface for type ExecHealthProbeProperties.

func (ExecHealthProbeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExecHealthProbeProperties.

func (*ExecHealthProbeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExecHealthProbeProperties.

type ExtenderProperties 

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

	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

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

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

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

	// The secrets for referenced resource
	Secrets map[string]any

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

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

ExtenderProperties - ExtenderResource portable resource properties

func (ExtenderProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtenderProperties.

func (*ExtenderProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtenderProperties.

type ExtenderResource 

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

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

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

ExtenderResource portable resource

func (*ExtenderResource) ConvertFrom 

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

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

func (*ExtenderResource) ConvertTo 

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

ConvertTo converts from the versioned Extender resource to version-agnostic datamodel and returns it, or an error if the conversion fails.

func (ExtenderResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtenderResource.

func (*ExtenderResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtenderResource.

type ExtenderResourceListResult 

type ExtenderResourceListResult struct {
	// REQUIRED; The ExtenderResource items on this page
	Value []*ExtenderResource

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

ExtenderResourceListResult - The response of a ExtenderResource list operation.

func (ExtenderResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtenderResourceListResult.

func (*ExtenderResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtenderResourceListResult.

type ExtenderResourceUpdate 

type ExtenderResourceUpdate 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
}

ExtenderResourceUpdate - ExtenderResource portable resource

func (ExtenderResourceUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ExtenderResourceUpdate.

func (*ExtenderResourceUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ExtenderResourceUpdate.

type ExtendersClient 

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

ExtendersClient contains the methods for the Extenders group. Don't use this type directly, use NewExtendersClient() instead.

func NewExtendersClient 

func NewExtendersClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*ExtendersClient, error)

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

func (client *ExtendersClient) BeginCreateOrUpdate(ctx context.Context, extenderName string, resource ExtenderResource, options *ExtendersClientBeginCreateOrUpdateOptions) (*runtime.Poller[ExtendersClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • extenderName - The name of the ExtenderResource portable resource
  • resource - Resource create parameters.
  • options - ExtendersClientBeginCreateOrUpdateOptions contains the optional parameters for the ExtendersClient.BeginCreateOrUpdate method.

func (*ExtendersClient) BeginDelete 

func (client *ExtendersClient) BeginDelete(ctx context.Context, extenderName string, options *ExtendersClientBeginDeleteOptions) (*runtime.Poller[ExtendersClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • extenderName - The name of the ExtenderResource portable resource
  • options - ExtendersClientBeginDeleteOptions contains the optional parameters for the ExtendersClient.BeginDelete method.

func (*ExtendersClient) BeginUpdate 

func (client *ExtendersClient) BeginUpdate(ctx context.Context, extenderName string, properties ExtenderResourceUpdate, options *ExtendersClientBeginUpdateOptions) (*runtime.Poller[ExtendersClientUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • extenderName - The name of the ExtenderResource portable resource
  • properties - The resource properties to be updated.
  • options - ExtendersClientBeginUpdateOptions contains the optional parameters for the ExtendersClient.BeginUpdate method.

func (*ExtendersClient) Get 

func (client *ExtendersClient) Get(ctx context.Context, extenderName string, options *ExtendersClientGetOptions) (ExtendersClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • extenderName - The name of the ExtenderResource portable resource
  • options - ExtendersClientGetOptions contains the optional parameters for the ExtendersClient.Get method.

func (*ExtendersClient) ListSecrets 

func (client *ExtendersClient) ListSecrets(ctx context.Context, extenderName string, body map[string]any, options *ExtendersClientListSecretsOptions) (ExtendersClientListSecretsResponse, error)

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

Generated from API version 2023-10-01-preview

  • extenderName - The name of the ExtenderResource portable resource
  • body - The content of the action request
  • options - ExtendersClientListSecretsOptions contains the optional parameters for the ExtendersClient.ListSecrets method.

func (*ExtendersClient) NewListByScopePager 

func (client *ExtendersClient) NewListByScopePager(options *ExtendersClientListByScopeOptions) *runtime.Pager[ExtendersClientListByScopeResponse]

NewListByScopePager - List ExtenderResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - ExtendersClientListByScopeOptions contains the optional parameters for the ExtendersClient.NewListByScopePager method.

type ExtendersClientBeginCreateOrUpdateOptions 

type ExtendersClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ExtendersClientBeginCreateOrUpdateOptions contains the optional parameters for the ExtendersClient.BeginCreateOrUpdate method.

type ExtendersClientBeginDeleteOptions 

type ExtendersClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ExtendersClientBeginDeleteOptions contains the optional parameters for the ExtendersClient.BeginDelete method.

type ExtendersClientBeginUpdateOptions 

type ExtendersClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

ExtendersClientBeginUpdateOptions contains the optional parameters for the ExtendersClient.BeginUpdate method.

type ExtendersClientCreateOrUpdateResponse 

type ExtendersClientCreateOrUpdateResponse struct {
	// ExtenderResource portable resource
	ExtenderResource
}

ExtendersClientCreateOrUpdateResponse contains the response from method ExtendersClient.BeginCreateOrUpdate.

type ExtendersClientDeleteResponse 

type ExtendersClientDeleteResponse struct {
}

ExtendersClientDeleteResponse contains the response from method ExtendersClient.BeginDelete.

type ExtendersClientGetOptions 

type ExtendersClientGetOptions struct {
}

ExtendersClientGetOptions contains the optional parameters for the ExtendersClient.Get method.

type ExtendersClientGetResponse 

type ExtendersClientGetResponse struct {
	// ExtenderResource portable resource
	ExtenderResource
}

ExtendersClientGetResponse contains the response from method ExtendersClient.Get.

type ExtendersClientListByScopeOptions 

type ExtendersClientListByScopeOptions struct {
}

ExtendersClientListByScopeOptions contains the optional parameters for the ExtendersClient.NewListByScopePager method.

type ExtendersClientListByScopeResponse 

type ExtendersClientListByScopeResponse struct {
	// The response of a ExtenderResource list operation.
	ExtenderResourceListResult
}

ExtendersClientListByScopeResponse contains the response from method ExtendersClient.NewListByScopePager.

type ExtendersClientListSecretsOptions 

type ExtendersClientListSecretsOptions struct {
}

ExtendersClientListSecretsOptions contains the optional parameters for the ExtendersClient.ListSecrets method.

type ExtendersClientListSecretsResponse 

type ExtendersClientListSecretsResponse struct {
	// Response for list secrets API call
	Value map[string]any
}

ExtendersClientListSecretsResponse contains the response from method ExtendersClient.ListSecrets.

type ExtendersClientUpdateResponse 

type ExtendersClientUpdateResponse struct {
	// ExtenderResource portable resource
	ExtenderResource
}

ExtendersClientUpdateResponse contains the response from method ExtendersClient.BeginUpdate.

type Extension 

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

Extension of a environment/application resource.

func (*Extension) GetExtension 

func (e *Extension) GetExtension() *Extension

GetExtension implements the ExtensionClassification interface for type Extension.

func (Extension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type Extension.

func (*Extension) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type Extension.

type ExtensionClassification 

type ExtensionClassification interface {
	// GetExtension returns the Extension content of the underlying type.
	GetExtension() *Extension
}

ExtensionClassification provides polymorphic access to related types. Call the interface's GetExtension() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *DaprSidecarExtension, *Extension, *KubernetesMetadataExtension, *KubernetesNamespaceExtension, *ManualScalingExtension

type GatewayHostname 

type GatewayHostname struct {
	// Specify a fully-qualified domain name: myapp.mydomain.com. Mutually exclusive with 'prefix' and will take priority if both
	// are defined.
	FullyQualifiedHostname *string

	// Specify a prefix for the hostname: myhostname.myapp.PUBLICHOSTNAMEORIP.nip.io. Mutually exclusive with 'fullyQualifiedHostname'
	// and will be overridden if both are defined.
	Prefix *string
}

GatewayHostname - Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io.

func (GatewayHostname) MarshalJSON 

func (g GatewayHostname) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayHostname.

func (*GatewayHostname) UnmarshalJSON 

func (g *GatewayHostname) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayHostname.

type GatewayProperties 

type GatewayProperties struct {
	// REQUIRED; Fully qualified resource ID for the application
	Application *string

	// REQUIRED; Routes attached to this Gateway
	Routes []*GatewayRoute

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

	// Declare hostname information for the Gateway. Leaving the hostname empty auto-assigns one: mygateway.myapp.PUBLICHOSTNAMEORIP.nip.io.
	Hostname *GatewayHostname

	// Sets Gateway to not be exposed externally (no public IP address associated). Defaults to false (exposed to internet).
	Internal *bool

	// TLS configuration for the Gateway.
	TLS *GatewayTLS

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

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

	// READ-ONLY; URL of the gateway resource. Readonly
	URL *string
}

GatewayProperties - Gateway properties

func (GatewayProperties) MarshalJSON 

func (g GatewayProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayProperties.

func (*GatewayProperties) UnmarshalJSON 

func (g *GatewayProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayProperties.

type GatewayResource 

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

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

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

GatewayResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (*GatewayResource) ConvertFrom 

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

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

func (*GatewayResource) ConvertTo 

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

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

func (GatewayResource) MarshalJSON 

func (g GatewayResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayResource.

func (*GatewayResource) UnmarshalJSON 

func (g *GatewayResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayResource.

type GatewayResourceListResult 

type GatewayResourceListResult struct {
	// REQUIRED; The GatewayResource items on this page
	Value []*GatewayResource

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

GatewayResourceListResult - The response of a GatewayResource list operation.

func (GatewayResourceListResult) MarshalJSON 

func (g GatewayResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayResourceListResult.

func (*GatewayResourceListResult) UnmarshalJSON 

func (g *GatewayResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayResourceListResult.

type GatewayResourceUpdate 

type GatewayResourceUpdate 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
}

GatewayResourceUpdate - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (GatewayResourceUpdate) MarshalJSON 

func (g GatewayResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayResourceUpdate.

func (*GatewayResourceUpdate) UnmarshalJSON 

func (g *GatewayResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayResourceUpdate.

type GatewayRoute 

type GatewayRoute struct {
	// The URL or id of the service to route to. Ex - 'http://myservice'.
	Destination *string

	// Enables websocket support for the route. Defaults to false.
	EnableWebsockets *bool

	// The path to match the incoming request path on. Ex - /myservice.
	Path *string

	// Optionally update the prefix when sending the request to the service. Ex - replacePrefix: '/' and path: '/myservice' will
	// transform '/myservice/myroute' to '/myroute'
	ReplacePrefix *string
}

GatewayRoute - Route attached to Gateway

func (GatewayRoute) MarshalJSON 

func (g GatewayRoute) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayRoute.

func (*GatewayRoute) UnmarshalJSON 

func (g *GatewayRoute) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayRoute.

type GatewayTLS 

type GatewayTLS struct {
	// The resource id for the secret containing the TLS certificate and key for the gateway.
	CertificateFrom *string

	// TLS minimum protocol version (defaults to 1.2).
	MinimumProtocolVersion *TLSMinVersion

	// If true, gateway lets the https traffic sslPassthrough to the backend servers for decryption.
	SSLPassthrough *bool
}

GatewayTLS - TLS configuration definition for Gateway resource.

func (GatewayTLS) MarshalJSON 

func (g GatewayTLS) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GatewayTLS.

func (*GatewayTLS) UnmarshalJSON 

func (g *GatewayTLS) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GatewayTLS.

type GatewaysClient 

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

GatewaysClient contains the methods for the Gateways group. Don't use this type directly, use NewGatewaysClient() instead.

func NewGatewaysClient 

func NewGatewaysClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*GatewaysClient, error)

NewGatewaysClient creates a new instance of GatewaysClient 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 (*GatewaysClient) BeginCreate 

func (client *GatewaysClient) BeginCreate(ctx context.Context, gatewayName string, resource GatewayResource, options *GatewaysClientBeginCreateOptions) (*runtime.Poller[GatewaysClientCreateResponse], error)

BeginCreate - Create a GatewayResource If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • gatewayName - Gateway name
  • resource - Resource create parameters.
  • options - GatewaysClientBeginCreateOptions contains the optional parameters for the GatewaysClient.BeginCreate method.

func (*GatewaysClient) BeginCreateOrUpdate 

func (client *GatewaysClient) BeginCreateOrUpdate(ctx context.Context, gatewayName string, properties GatewayResourceUpdate, options *GatewaysClientBeginCreateOrUpdateOptions) (*runtime.Poller[GatewaysClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • gatewayName - Gateway name
  • properties - The resource properties to be updated.
  • options - GatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewaysClient.BeginCreateOrUpdate method.

func (*GatewaysClient) BeginDelete 

func (client *GatewaysClient) BeginDelete(ctx context.Context, gatewayName string, options *GatewaysClientBeginDeleteOptions) (*runtime.Poller[GatewaysClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • gatewayName - Gateway name
  • options - GatewaysClientBeginDeleteOptions contains the optional parameters for the GatewaysClient.BeginDelete method.

func (*GatewaysClient) Get 

func (client *GatewaysClient) Get(ctx context.Context, gatewayName string, options *GatewaysClientGetOptions) (GatewaysClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • gatewayName - Gateway name
  • options - GatewaysClientGetOptions contains the optional parameters for the GatewaysClient.Get method.

func (*GatewaysClient) NewListByScopePager 

func (client *GatewaysClient) NewListByScopePager(options *GatewaysClientListByScopeOptions) *runtime.Pager[GatewaysClientListByScopeResponse]

NewListByScopePager - List GatewayResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - GatewaysClientListByScopeOptions contains the optional parameters for the GatewaysClient.NewListByScopePager method.

type GatewaysClientBeginCreateOptions 

type GatewaysClientBeginCreateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

GatewaysClientBeginCreateOptions contains the optional parameters for the GatewaysClient.BeginCreate method.

type GatewaysClientBeginCreateOrUpdateOptions 

type GatewaysClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

GatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewaysClient.BeginCreateOrUpdate method.

type GatewaysClientBeginDeleteOptions 

type GatewaysClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

GatewaysClientBeginDeleteOptions contains the optional parameters for the GatewaysClient.BeginDelete method.

type GatewaysClientCreateOrUpdateResponse 

type GatewaysClientCreateOrUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	GatewayResource
}

GatewaysClientCreateOrUpdateResponse contains the response from method GatewaysClient.BeginCreateOrUpdate.

type GatewaysClientCreateResponse 

type GatewaysClientCreateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	GatewayResource
}

GatewaysClientCreateResponse contains the response from method GatewaysClient.BeginCreate.

type GatewaysClientDeleteResponse 

type GatewaysClientDeleteResponse struct {
}

GatewaysClientDeleteResponse contains the response from method GatewaysClient.BeginDelete.

type GatewaysClientGetOptions 

type GatewaysClientGetOptions struct {
}

GatewaysClientGetOptions contains the optional parameters for the GatewaysClient.Get method.

type GatewaysClientGetResponse 

type GatewaysClientGetResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	GatewayResource
}

GatewaysClientGetResponse contains the response from method GatewaysClient.Get.

type GatewaysClientListByScopeOptions 

type GatewaysClientListByScopeOptions struct {
}

GatewaysClientListByScopeOptions contains the optional parameters for the GatewaysClient.NewListByScopePager method.

type GatewaysClientListByScopeResponse 

type GatewaysClientListByScopeResponse struct {
	// The response of a GatewayResource list operation.
	GatewayResourceListResult
}

GatewaysClientListByScopeResponse contains the response from method GatewaysClient.NewListByScopePager.

type GitAuthConfig added in v0.31.0 

type GitAuthConfig struct {
	// Personal Access Token (PAT) configuration used to authenticate to Git platforms.
	Pat map[string]*SecretConfig
}

GitAuthConfig - Authentication information used to access private Terraform modules from Git repository sources.

func (GitAuthConfig) MarshalJSON added in v0.31.0 

func (g GitAuthConfig) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type GitAuthConfig.

func (*GitAuthConfig) UnmarshalJSON added in v0.31.0 

func (g *GitAuthConfig) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type GitAuthConfig.

type HTTPGetHealthProbeProperties 

type HTTPGetHealthProbeProperties struct {
	// REQUIRED; The listening port number
	ContainerPort *int32

	// REQUIRED; Discriminator property for HealthProbeProperties.
	Kind *string

	// REQUIRED; The route to make the HTTP request on
	Path *string

	// Threshold number of times the probe fails after which a failure would be reported
	FailureThreshold *float32

	// Custom HTTP headers to add to the get request
	Headers map[string]*string

	// Initial delay in seconds before probing for readiness/liveness
	InitialDelaySeconds *float32

	// Interval for the readiness/liveness probe in seconds
	PeriodSeconds *float32

	// Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds
	TimeoutSeconds *float32
}

HTTPGetHealthProbeProperties - Specifies the properties for readiness/liveness probe using HTTP Get

func (*HTTPGetHealthProbeProperties) GetHealthProbeProperties 

func (h *HTTPGetHealthProbeProperties) GetHealthProbeProperties() *HealthProbeProperties

GetHealthProbeProperties implements the HealthProbePropertiesClassification interface for type HTTPGetHealthProbeProperties.

func (HTTPGetHealthProbeProperties) MarshalJSON 

func (h HTTPGetHealthProbeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HTTPGetHealthProbeProperties.

func (*HTTPGetHealthProbeProperties) UnmarshalJSON 

func (h *HTTPGetHealthProbeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HTTPGetHealthProbeProperties.

type HealthProbeProperties 

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

	// Threshold number of times the probe fails after which a failure would be reported
	FailureThreshold *float32

	// Initial delay in seconds before probing for readiness/liveness
	InitialDelaySeconds *float32

	// Interval for the readiness/liveness probe in seconds
	PeriodSeconds *float32

	// Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds
	TimeoutSeconds *float32
}

HealthProbeProperties - Properties for readiness/liveness probe

func (*HealthProbeProperties) GetHealthProbeProperties 

func (h *HealthProbeProperties) GetHealthProbeProperties() *HealthProbeProperties

GetHealthProbeProperties implements the HealthProbePropertiesClassification interface for type HealthProbeProperties.

func (HealthProbeProperties) MarshalJSON 

func (h HealthProbeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type HealthProbeProperties.

func (*HealthProbeProperties) UnmarshalJSON 

func (h *HealthProbeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type HealthProbeProperties.

type HealthProbePropertiesClassification 

type HealthProbePropertiesClassification interface {
	// GetHealthProbeProperties returns the HealthProbeProperties content of the underlying type.
	GetHealthProbeProperties() *HealthProbeProperties
}

HealthProbePropertiesClassification provides polymorphic access to related types. Call the interface's GetHealthProbeProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *ExecHealthProbeProperties, *HTTPGetHealthProbeProperties, *HealthProbeProperties, *TCPHealthProbeProperties

type IAMKind 

type IAMKind string

IAMKind - The kind of IAM provider to configure 

const (
	// IAMKindAzure - Azure Active Directory
	IAMKindAzure  IAMKind = "azure"
	IAMKindString IAMKind = "string"
)

func PossibleIAMKindValues 

func PossibleIAMKindValues() []IAMKind

PossibleIAMKindValues returns the possible values for the IAMKind const type.

type IamProperties 

type IamProperties struct {
	// REQUIRED; The kind of IAM provider to configure
	Kind *IAMKind

	// RBAC permissions to be assigned on the source resource
	Roles []*string
}

IamProperties - IAM properties

func (IamProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type IamProperties.

func (*IamProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type IamProperties.

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 ImagePullPolicy 

type ImagePullPolicy string

ImagePullPolicy - The image pull policy for the container 

const (
	// ImagePullPolicyAlways - Always
	ImagePullPolicyAlways ImagePullPolicy = "Always"
	// ImagePullPolicyIfNotPresent - IfNotPresent
	ImagePullPolicyIfNotPresent ImagePullPolicy = "IfNotPresent"
	// ImagePullPolicyNever - Never
	ImagePullPolicyNever ImagePullPolicy = "Never"
)

func PossibleImagePullPolicyValues 

func PossibleImagePullPolicyValues() []ImagePullPolicy

PossibleImagePullPolicyValues returns the possible values for the ImagePullPolicy const type.

type KeyObjectProperties 

type KeyObjectProperties struct {
	// REQUIRED; The name of the key
	Name *string

	// File name when written to disk
	Alias *string

	// Key version
	Version *string
}

KeyObjectProperties - Represents key object properties

func (KeyObjectProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KeyObjectProperties.

func (*KeyObjectProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KeyObjectProperties.

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 KubernetesMetadataExtension 

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

	// Annotations to be applied to the Kubernetes resources output by the resource
	Annotations map[string]*string

	// Labels to be applied to the Kubernetes resources output by the resource
	Labels map[string]*string
}

KubernetesMetadataExtension - Kubernetes metadata extension of a environment/application resource.

func (*KubernetesMetadataExtension) GetExtension 

func (k *KubernetesMetadataExtension) GetExtension() *Extension

GetExtension implements the ExtensionClassification interface for type KubernetesMetadataExtension.

func (KubernetesMetadataExtension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesMetadataExtension.

func (*KubernetesMetadataExtension) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesMetadataExtension.

type KubernetesNamespaceExtension 

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

	// REQUIRED; The namespace of the application environment.
	Namespace *string
}

KubernetesNamespaceExtension - Kubernetes namespace extension of a environment/application resource.

func (*KubernetesNamespaceExtension) GetExtension 

func (k *KubernetesNamespaceExtension) GetExtension() *Extension

GetExtension implements the ExtensionClassification interface for type KubernetesNamespaceExtension.

func (KubernetesNamespaceExtension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesNamespaceExtension.

func (*KubernetesNamespaceExtension) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesNamespaceExtension.

type KubernetesRuntimeProperties 

type KubernetesRuntimeProperties struct {
	// The serialized YAML manifest which represents the base Kubernetes resources to deploy, such as Deployment, Service, ServiceAccount,
	// Secrets, and ConfigMaps.
	Base *string

	// A strategic merge patch that will be applied to the PodSpec object when this container is being deployed.
	Pod map[string]any
}

KubernetesRuntimeProperties - The runtime configuration properties for Kubernetes

func (KubernetesRuntimeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type KubernetesRuntimeProperties.

func (*KubernetesRuntimeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type KubernetesRuntimeProperties.

type ManagedStore 

type ManagedStore string

ManagedStore - The managed store for the ephemeral volume 

const (
	// ManagedStoreDisk - Disk store
	ManagedStoreDisk ManagedStore = "disk"
	// ManagedStoreMemory - Memory store
	ManagedStoreMemory ManagedStore = "memory"
)

func PossibleManagedStoreValues 

func PossibleManagedStoreValues() []ManagedStore

PossibleManagedStoreValues returns the possible values for the ManagedStore const type.

type ManualScalingExtension 

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

	// REQUIRED; Replica count.
	Replicas *int32
}

ManualScalingExtension - ManualScaling Extension

func (*ManualScalingExtension) GetExtension 

func (m *ManualScalingExtension) GetExtension() *Extension

GetExtension implements the ExtensionClassification interface for type ManualScalingExtension.

func (ManualScalingExtension) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type ManualScalingExtension.

func (*ManualScalingExtension) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ManualScalingExtension.

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 PersistentVolume 

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

	// REQUIRED; The source of the volume
	Source *string

	// The path where the volume is mounted
	MountPath *string

	// Container read/write access to the volume
	Permission *VolumePermission
}

PersistentVolume - Specifies a persistent volume for a container

func (*PersistentVolume) GetVolume 

func (p *PersistentVolume) GetVolume() *Volume

GetVolume implements the VolumeClassification interface for type PersistentVolume.

func (PersistentVolume) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type PersistentVolume.

func (*PersistentVolume) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type PersistentVolume.

type PortProtocol 

type PortProtocol string

PortProtocol - The protocol in use by the port 

const (
	// PortProtocolTCP - TCP protocol
	PortProtocolTCP PortProtocol = "TCP"
	// PortProtocolUDP - UDP protocol
	PortProtocolUDP PortProtocol = "UDP"
)

func PossiblePortProtocolValues 

func PossiblePortProtocolValues() []PortProtocol

PossiblePortProtocolValues returns the possible values for the PortProtocol const type.

type ProviderConfigProperties added in v0.36.0 

type ProviderConfigProperties struct {
	// OPTIONAL; Contains additional key/value pairs not defined in the schema.
	AdditionalProperties map[string]any

	// Sensitive data in provider configuration can be stored as secrets. The secrets are stored in Applications.Core/SecretStores
	// resource.
	Secrets map[string]*SecretReference
}

ProviderConfigProperties - This configuration holds the necessary information to authenticate and interact with a provider for the recipe execution.

func (ProviderConfigProperties) MarshalJSON added in v0.36.0 

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

MarshalJSON implements the json.Marshaller interface for type ProviderConfigProperties.

func (*ProviderConfigProperties) UnmarshalJSON added in v0.36.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type ProviderConfigProperties.

type Providers 

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

	// The Azure cloud provider configuration.
	Azure *ProvidersAzure
}

Providers - The Cloud providers configuration.

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; Target scope for AWS resources to be deployed into. For example: '/planes/aws/aws/accounts/000000000000/regions/us-west-2'.
	Scope *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; Target scope for Azure resources to be deployed into. For example: '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup'.
	Scope *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 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 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 RecipeConfigProperties added in v0.31.0 

type RecipeConfigProperties struct {
	// Configuration for Bicep Recipes. Controls how Bicep plans and applies templates as part of Recipe deployment.
	Bicep *BicepConfigProperties

	// Environment variables injected during recipe execution for the recipes in the environment, currently supported for Terraform
	// recipes.
	Env map[string]*string

	// Environment variables containing sensitive information can be stored as secrets. The secrets are stored in Applications.Core/SecretStores
	// resource.
	EnvSecrets map[string]*SecretReference

	// Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment.
	Terraform *TerraformConfigProperties
}

RecipeConfigProperties - Configuration for Recipes. Defines how each type of Recipe should be configured and run.

func (RecipeConfigProperties) MarshalJSON added in v0.31.0 

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

MarshalJSON implements the json.Marshaller interface for type RecipeConfigProperties.

func (*RecipeConfigProperties) UnmarshalJSON added in v0.31.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeConfigProperties.

type RecipeGetMetadata 

type RecipeGetMetadata struct {
	// REQUIRED; The name of the recipe registered to the environment.
	Name *string

	// REQUIRED; Type of the resource this recipe can be consumed by. For example: 'Applications.Datastores/mongoDatabases'.
	ResourceType *string
}

RecipeGetMetadata - Represents the request body of the getmetadata action.

func (*RecipeGetMetadata) ConvertTo 

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

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

func (RecipeGetMetadata) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RecipeGetMetadata.

func (*RecipeGetMetadata) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeGetMetadata.

type RecipeGetMetadataResponse 

type RecipeGetMetadataResponse struct {
	// REQUIRED; The key/value parameters to pass to the recipe template at deployment.
	Parameters map[string]any

	// REQUIRED; The format of the template provided by the recipe. Allowed values: bicep, terraform.
	TemplateKind *string

	// REQUIRED; The path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
	TemplatePath *string

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

	// The version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted
	// for other module sources.
	TemplateVersion *string
}

RecipeGetMetadataResponse - The properties of a Recipe linked to an Environment.

func (*RecipeGetMetadataResponse) ConvertFrom 

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

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

func (*RecipeGetMetadataResponse) ConvertTo 

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

ConvertTo returns an error as it does not support converting Environment Recipe Properties to a version-agnostic object.

func (RecipeGetMetadataResponse) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RecipeGetMetadataResponse.

func (*RecipeGetMetadataResponse) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeGetMetadataResponse.

type RecipeProperties 

type RecipeProperties struct {
	// REQUIRED; Discriminator property for RecipeProperties.
	TemplateKind *string

	// REQUIRED; Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
	TemplatePath *string

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

RecipeProperties - Format of the template provided by the recipe. Allowed values: bicep, terraform.

func (*RecipeProperties) GetRecipeProperties 

func (r *RecipeProperties) GetRecipeProperties() *RecipeProperties

GetRecipeProperties implements the RecipePropertiesClassification interface for type RecipeProperties.

func (RecipeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RecipeProperties.

func (*RecipeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RecipeProperties.

type RecipePropertiesClassification 

type RecipePropertiesClassification interface {
	// GetRecipeProperties returns the RecipeProperties content of the underlying type.
	GetRecipeProperties() *RecipeProperties
}

RecipePropertiesClassification provides polymorphic access to related types. Call the interface's GetRecipeProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *BicepRecipeProperties, *RecipeProperties, *TerraformRecipeProperties

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

type RegistrySecretConfig struct {
	// The ID of an Applications.Core/SecretStore resource containing credential information used to authenticate private container
	// registry.The keys in the secretstore depends on the type.
	Secret *string
}

RegistrySecretConfig - Registry Secret Configuration used to authenticate to private bicep registries.

func (RegistrySecretConfig) MarshalJSON added in v0.38.0 

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

MarshalJSON implements the json.Marshaller interface for type RegistrySecretConfig.

func (*RegistrySecretConfig) UnmarshalJSON added in v0.38.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RegistrySecretConfig.

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

type RestartPolicy string

RestartPolicy - Restart policy for the container 

const (
	// RestartPolicyAlways - Always
	RestartPolicyAlways RestartPolicy = "Always"
	// RestartPolicyNever - Never
	RestartPolicyNever RestartPolicy = "Never"
	// RestartPolicyOnFailure - OnFailure
	RestartPolicyOnFailure RestartPolicy = "OnFailure"
)

func PossibleRestartPolicyValues added in v0.27.0 

func PossibleRestartPolicyValues() []RestartPolicy

PossibleRestartPolicyValues returns the possible values for the RestartPolicy const type.

type RuntimesProperties 

type RuntimesProperties struct {
	// The runtime configuration properties for Kubernetes
	Kubernetes *KubernetesRuntimeProperties
}

RuntimesProperties - The properties for runtime configuration

func (RuntimesProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type RuntimesProperties.

func (*RuntimesProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type RuntimesProperties.

type SecretConfig added in v0.31.0 

type SecretConfig struct {
	// The ID of an Applications.Core/SecretStore resource containing the Git platform personal access token (PAT). The secret
	// store must have a secret named 'pat', containing the PAT value. A secret named
	// 'username' is optional, containing the username associated with the pat. By default no username is specified.
	Secret *string
}

SecretConfig - Personal Access Token (PAT) configuration used to authenticate to Git platforms.

func (SecretConfig) MarshalJSON added in v0.31.0 

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

MarshalJSON implements the json.Marshaller interface for type SecretConfig.

func (*SecretConfig) UnmarshalJSON added in v0.31.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretConfig.

type SecretObjectProperties 

type SecretObjectProperties struct {
	// REQUIRED; The name of the secret
	Name *string

	// File name when written to disk
	Alias *string

	// Encoding format. Default utf-8
	Encoding *VolumeSecretEncodings

	// secret version
	Version *string
}

SecretObjectProperties - Represents secret object properties

func (SecretObjectProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretObjectProperties.

func (*SecretObjectProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretObjectProperties.

type SecretReference added in v0.36.0 

type SecretReference struct {
	// REQUIRED; The key for the secret in the secret store.
	Key *string

	// REQUIRED; The ID of an Applications.Core/SecretStore resource containing sensitive data required for recipe execution.
	Source *string
}

SecretReference - This secret is used within a recipe. Secrets are encrypted, often have fine-grained access control, auditing and are recommended to be used to hold sensitive data.

func (SecretReference) MarshalJSON added in v0.36.0 

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

MarshalJSON implements the json.Marshaller interface for type SecretReference.

func (*SecretReference) UnmarshalJSON added in v0.36.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretReference.

type SecretStoreDataType 

type SecretStoreDataType string

SecretStoreDataType - The type of SecretStore data 

const (
	// SecretStoreDataTypeAwsIRSA - awsIRSA type is used to represent authentication using AWS IRSA (IAM Roles for Service accounts)
	// and the secretstore resource is expected to have the key 'roleARN'.
	SecretStoreDataTypeAwsIRSA SecretStoreDataType = "awsIRSA"
	// SecretStoreDataTypeAzureWorkloadIdentity - azureWorkloadIdentity type is used to represent authentication using azure federated
	// identity and the secretstore resource is expected to have the keys 'clientId' and 'tenantId'.
	SecretStoreDataTypeAzureWorkloadIdentity SecretStoreDataType = "azureWorkloadIdentity"
	// SecretStoreDataTypeBasicAuthentication - basicAuthentication type is used to represent username and password based authentication
	// and the secretstore resource is expected to have the keys 'username' and 'password'.
	SecretStoreDataTypeBasicAuthentication SecretStoreDataType = "basicAuthentication"
	// SecretStoreDataTypeCertificate - Certificate secret data type
	SecretStoreDataTypeCertificate SecretStoreDataType = "certificate"
	// SecretStoreDataTypeGeneric - Generic secret data type
	SecretStoreDataTypeGeneric SecretStoreDataType = "generic"
)

func PossibleSecretStoreDataTypeValues 

func PossibleSecretStoreDataTypeValues() []SecretStoreDataType

PossibleSecretStoreDataTypeValues returns the possible values for the SecretStoreDataType const type.

type SecretStoreListSecretsResult 

type SecretStoreListSecretsResult struct {
	// REQUIRED; An object to represent key-value type secrets
	Data map[string]*SecretValueProperties

	// REQUIRED; The type of secret store data
	Type *SecretStoreDataType
}

SecretStoreListSecretsResult - The list of secrets

func (SecretStoreListSecretsResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreListSecretsResult.

func (*SecretStoreListSecretsResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreListSecretsResult.

type SecretStoreProperties 

type SecretStoreProperties struct {
	// REQUIRED; An object to represent key-value type secrets
	Data map[string]*SecretValueProperties

	// Fully qualified resource ID for the application
	Application *string

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

	// The resource id of external secret store.
	Resource *string

	// The type of secret store data
	Type *SecretStoreDataType

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

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

SecretStoreProperties - The properties of SecretStore

func (SecretStoreProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreProperties.

func (*SecretStoreProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreProperties.

type SecretStoreResource 

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

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

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

SecretStoreResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (*SecretStoreResource) ConvertFrom 

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

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

func (*SecretStoreResource) ConvertTo 

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

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

func (SecretStoreResource) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreResource.

func (*SecretStoreResource) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreResource.

type SecretStoreResourceListResult 

type SecretStoreResourceListResult struct {
	// REQUIRED; The SecretStoreResource items on this page
	Value []*SecretStoreResource

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

SecretStoreResourceListResult - The response of a SecretStoreResource list operation.

func (SecretStoreResourceListResult) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreResourceListResult.

func (*SecretStoreResourceListResult) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreResourceListResult.

type SecretStoreResourceUpdate 

type SecretStoreResourceUpdate 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
}

SecretStoreResourceUpdate - Concrete tracked resource types can be created by aliasing this type using a specific property type.

func (SecretStoreResourceUpdate) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretStoreResourceUpdate.

func (*SecretStoreResourceUpdate) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretStoreResourceUpdate.

type SecretStoresClient 

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

SecretStoresClient contains the methods for the SecretStores group. Don't use this type directly, use NewSecretStoresClient() instead.

func NewSecretStoresClient 

func NewSecretStoresClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*SecretStoresClient, error)

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

func (client *SecretStoresClient) BeginCreateOrUpdate(ctx context.Context, secretStoreName string, resource SecretStoreResource, options *SecretStoresClientBeginCreateOrUpdateOptions) (*runtime.Poller[SecretStoresClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • secretStoreName - SecretStore name
  • resource - Resource create parameters.
  • options - SecretStoresClientBeginCreateOrUpdateOptions contains the optional parameters for the SecretStoresClient.BeginCreateOrUpdate method.

func (*SecretStoresClient) BeginDelete 

func (client *SecretStoresClient) BeginDelete(ctx context.Context, secretStoreName string, options *SecretStoresClientBeginDeleteOptions) (*runtime.Poller[SecretStoresClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • secretStoreName - SecretStore name
  • options - SecretStoresClientBeginDeleteOptions contains the optional parameters for the SecretStoresClient.BeginDelete method.

func (*SecretStoresClient) BeginUpdate 

func (client *SecretStoresClient) BeginUpdate(ctx context.Context, secretStoreName string, properties SecretStoreResourceUpdate, options *SecretStoresClientBeginUpdateOptions) (*runtime.Poller[SecretStoresClientUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • secretStoreName - SecretStore name
  • properties - The resource properties to be updated.
  • options - SecretStoresClientBeginUpdateOptions contains the optional parameters for the SecretStoresClient.BeginUpdate method.

func (*SecretStoresClient) Get 

func (client *SecretStoresClient) Get(ctx context.Context, secretStoreName string, options *SecretStoresClientGetOptions) (SecretStoresClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • secretStoreName - SecretStore name
  • options - SecretStoresClientGetOptions contains the optional parameters for the SecretStoresClient.Get method.

func (*SecretStoresClient) ListSecrets 

func (client *SecretStoresClient) ListSecrets(ctx context.Context, secretStoreName string, body map[string]any, options *SecretStoresClientListSecretsOptions) (SecretStoresClientListSecretsResponse, error)

ListSecrets - List the secrets of a secret stores. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2023-10-01-preview

  • secretStoreName - SecretStore name
  • body - The content of the action request
  • options - SecretStoresClientListSecretsOptions contains the optional parameters for the SecretStoresClient.ListSecrets method.

func (*SecretStoresClient) NewListByScopePager 

func (client *SecretStoresClient) NewListByScopePager(options *SecretStoresClientListByScopeOptions) *runtime.Pager[SecretStoresClientListByScopeResponse]

NewListByScopePager - List SecretStoreResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - SecretStoresClientListByScopeOptions contains the optional parameters for the SecretStoresClient.NewListByScopePager method.

type SecretStoresClientBeginCreateOrUpdateOptions 

type SecretStoresClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

SecretStoresClientBeginCreateOrUpdateOptions contains the optional parameters for the SecretStoresClient.BeginCreateOrUpdate method.

type SecretStoresClientBeginDeleteOptions 

type SecretStoresClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

SecretStoresClientBeginDeleteOptions contains the optional parameters for the SecretStoresClient.BeginDelete method.

type SecretStoresClientBeginUpdateOptions 

type SecretStoresClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

SecretStoresClientBeginUpdateOptions contains the optional parameters for the SecretStoresClient.BeginUpdate method.

type SecretStoresClientCreateOrUpdateResponse 

type SecretStoresClientCreateOrUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	SecretStoreResource
}

SecretStoresClientCreateOrUpdateResponse contains the response from method SecretStoresClient.BeginCreateOrUpdate.

type SecretStoresClientDeleteResponse 

type SecretStoresClientDeleteResponse struct {
}

SecretStoresClientDeleteResponse contains the response from method SecretStoresClient.BeginDelete.

type SecretStoresClientGetOptions 

type SecretStoresClientGetOptions struct {
}

SecretStoresClientGetOptions contains the optional parameters for the SecretStoresClient.Get method.

type SecretStoresClientGetResponse 

type SecretStoresClientGetResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	SecretStoreResource
}

SecretStoresClientGetResponse contains the response from method SecretStoresClient.Get.

type SecretStoresClientListByScopeOptions 

type SecretStoresClientListByScopeOptions struct {
}

SecretStoresClientListByScopeOptions contains the optional parameters for the SecretStoresClient.NewListByScopePager method.

type SecretStoresClientListByScopeResponse 

type SecretStoresClientListByScopeResponse struct {
	// The response of a SecretStoreResource list operation.
	SecretStoreResourceListResult
}

SecretStoresClientListByScopeResponse contains the response from method SecretStoresClient.NewListByScopePager.

type SecretStoresClientListSecretsOptions 

type SecretStoresClientListSecretsOptions struct {
}

SecretStoresClientListSecretsOptions contains the optional parameters for the SecretStoresClient.ListSecrets method.

type SecretStoresClientListSecretsResponse 

type SecretStoresClientListSecretsResponse struct {
	// The list of secrets
	SecretStoreListSecretsResult
}

SecretStoresClientListSecretsResponse contains the response from method SecretStoresClient.ListSecrets.

func (*SecretStoresClientListSecretsResponse) ConvertFrom 

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

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

func (*SecretStoresClientListSecretsResponse) ConvertTo 

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

ConvertTo does no-op because SecretStoresClientListSecretsResponse model is used only for response.

type SecretStoresClientUpdateResponse 

type SecretStoresClientUpdateResponse struct {
	// Concrete tracked resource types can be created by aliasing this type using a specific property type.
	SecretStoreResource
}

SecretStoresClientUpdateResponse contains the response from method SecretStoresClient.BeginUpdate.

type SecretValueEncoding 

type SecretValueEncoding string

SecretValueEncoding - The type of SecretValue Encoding 

const (
	// SecretValueEncodingBase64 - The base64-encoded secret value
	SecretValueEncodingBase64 SecretValueEncoding = "base64"
	// SecretValueEncodingRaw - The raw secret value
	SecretValueEncodingRaw SecretValueEncoding = "raw"
)

func PossibleSecretValueEncodingValues 

func PossibleSecretValueEncodingValues() []SecretValueEncoding

PossibleSecretValueEncodingValues returns the possible values for the SecretValueEncoding const type.

type SecretValueProperties 

type SecretValueProperties struct {
	// The encoding of value
	Encoding *SecretValueEncoding

	// The value of secret.
	Value *string

	// The referenced secret in properties.resource
	ValueFrom *ValueFromProperties
}

SecretValueProperties - The properties of SecretValue

func (SecretValueProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type SecretValueProperties.

func (*SecretValueProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type SecretValueProperties.

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 TCPHealthProbeProperties 

type TCPHealthProbeProperties struct {
	// REQUIRED; The listening port number
	ContainerPort *int32

	// REQUIRED; Discriminator property for HealthProbeProperties.
	Kind *string

	// Threshold number of times the probe fails after which a failure would be reported
	FailureThreshold *float32

	// Initial delay in seconds before probing for readiness/liveness
	InitialDelaySeconds *float32

	// Interval for the readiness/liveness probe in seconds
	PeriodSeconds *float32

	// Number of seconds after which the readiness/liveness probe times out. Defaults to 5 seconds
	TimeoutSeconds *float32
}

TCPHealthProbeProperties - Specifies the properties for readiness/liveness probe using TCP

func (*TCPHealthProbeProperties) GetHealthProbeProperties 

func (t *TCPHealthProbeProperties) GetHealthProbeProperties() *HealthProbeProperties

GetHealthProbeProperties implements the HealthProbePropertiesClassification interface for type TCPHealthProbeProperties.

func (TCPHealthProbeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TCPHealthProbeProperties.

func (*TCPHealthProbeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TCPHealthProbeProperties.

type TLSMinVersion 

type TLSMinVersion string

TLSMinVersion - TLS minimum protocol version (defaults to 1.2). 

const (
	// TLSMinVersionTls12 - TLS Version 1.2
	TLSMinVersionTls12 TLSMinVersion = "1.2"
	// TLSMinVersionTls13 - TLS Version 1.3
	TLSMinVersionTls13 TLSMinVersion = "1.3"
)

func PossibleTLSMinVersionValues 

func PossibleTLSMinVersionValues() []TLSMinVersion

PossibleTLSMinVersionValues returns the possible values for the TLSMinVersion const type.

type TerraformConfigProperties added in v0.31.0 

type TerraformConfigProperties struct {
	// Authentication information used to access private Terraform module sources. Supported module sources: Git.
	Authentication *AuthConfig

	// Configuration for Terraform Recipe Providers. Controls how Terraform interacts with cloud providers, SaaS providers, and
	// other APIs. For more information, please see:
	// https://developer.hashicorp.com/terraform/language/providers/configuration.
	Providers map[string][]*ProviderConfigProperties
}

TerraformConfigProperties - Configuration for Terraform Recipes. Controls how Terraform plans and applies templates as part of Recipe deployment.

func (TerraformConfigProperties) MarshalJSON added in v0.31.0 

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

MarshalJSON implements the json.Marshaller interface for type TerraformConfigProperties.

func (*TerraformConfigProperties) UnmarshalJSON added in v0.31.0 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TerraformConfigProperties.

type TerraformRecipeProperties 

type TerraformRecipeProperties struct {
	// REQUIRED; Discriminator property for RecipeProperties.
	TemplateKind *string

	// REQUIRED; Path to the template provided by the recipe. Currently only link to Azure Container Registry is supported.
	TemplatePath *string

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

	// Version of the template to deploy. For Terraform recipes using a module registry this is required, but must be omitted
	// for other module sources.
	TemplateVersion *string
}

TerraformRecipeProperties - Represents Terraform recipe properties.

func (*TerraformRecipeProperties) GetRecipeProperties 

func (t *TerraformRecipeProperties) GetRecipeProperties() *RecipeProperties

GetRecipeProperties implements the RecipePropertiesClassification interface for type TerraformRecipeProperties.

func (TerraformRecipeProperties) MarshalJSON 

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

MarshalJSON implements the json.Marshaller interface for type TerraformRecipeProperties.

func (*TerraformRecipeProperties) UnmarshalJSON 

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

UnmarshalJSON implements the json.Unmarshaller interface for type TerraformRecipeProperties.

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 ValueFromProperties 

type ValueFromProperties struct {
	// REQUIRED; The name of the referenced secret.
	Name *string

	// The version of the referenced secret.
	Version *string
}

ValueFromProperties - The Secret value source properties

func (ValueFromProperties) MarshalJSON 

func (v ValueFromProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ValueFromProperties.

func (*ValueFromProperties) UnmarshalJSON 

func (v *ValueFromProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ValueFromProperties.

type Volume 

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

	// The path where the volume is mounted
	MountPath *string
}

Volume - Specifies a volume for a container

func (*Volume) GetVolume 

func (v *Volume) GetVolume() *Volume

GetVolume implements the VolumeClassification interface for type Volume.

func (Volume) MarshalJSON 

func (v Volume) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Volume.

func (*Volume) UnmarshalJSON 

func (v *Volume) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Volume.

type VolumeClassification 

type VolumeClassification interface {
	// GetVolume returns the Volume content of the underlying type.
	GetVolume() *Volume
}

VolumeClassification provides polymorphic access to related types. Call the interface's GetVolume() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *EphemeralVolume, *PersistentVolume, *Volume

type VolumePermission 

type VolumePermission string

VolumePermission - The persistent volume permission 

const (
	// VolumePermissionRead - Read only
	VolumePermissionRead VolumePermission = "read"
	// VolumePermissionWrite - Read and write
	VolumePermissionWrite VolumePermission = "write"
)

func PossibleVolumePermissionValues 

func PossibleVolumePermissionValues() []VolumePermission

PossibleVolumePermissionValues returns the possible values for the VolumePermission const type.

type VolumeProperties 

type VolumeProperties struct {
	// REQUIRED; Fully qualified resource ID for the application
	Application *string

	// REQUIRED; Discriminator property for VolumeProperties.
	Kind *string

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

VolumeProperties - Volume properties

func (*VolumeProperties) GetVolumeProperties 

func (v *VolumeProperties) GetVolumeProperties() *VolumeProperties

GetVolumeProperties implements the VolumePropertiesClassification interface for type VolumeProperties.

func (VolumeProperties) MarshalJSON 

func (v VolumeProperties) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeProperties.

func (*VolumeProperties) UnmarshalJSON 

func (v *VolumeProperties) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeProperties.

type VolumePropertiesClassification 

type VolumePropertiesClassification interface {
	// GetVolumeProperties returns the VolumeProperties content of the underlying type.
	GetVolumeProperties() *VolumeProperties
}

VolumePropertiesClassification provides polymorphic access to related types. Call the interface's GetVolumeProperties() method to access the common type. Use a type switch to determine the concrete type. The possible types are: - *AzureKeyVaultVolumeProperties, *VolumeProperties

type VolumeResource 

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

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

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

VolumeResource - Radius Volume resource.

func (*VolumeResource) ConvertFrom 

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

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

func (*VolumeResource) ConvertTo 

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

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

func (VolumeResource) MarshalJSON 

func (v VolumeResource) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeResource.

func (*VolumeResource) UnmarshalJSON 

func (v *VolumeResource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeResource.

type VolumeResourceListResult 

type VolumeResourceListResult struct {
	// REQUIRED; The VolumeResource items on this page
	Value []*VolumeResource

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

VolumeResourceListResult - The response of a VolumeResource list operation.

func (VolumeResourceListResult) MarshalJSON 

func (v VolumeResourceListResult) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeResourceListResult.

func (*VolumeResourceListResult) UnmarshalJSON 

func (v *VolumeResourceListResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeResourceListResult.

type VolumeResourceUpdate 

type VolumeResourceUpdate 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
}

VolumeResourceUpdate - Radius Volume resource.

func (VolumeResourceUpdate) MarshalJSON 

func (v VolumeResourceUpdate) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type VolumeResourceUpdate.

func (*VolumeResourceUpdate) UnmarshalJSON 

func (v *VolumeResourceUpdate) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type VolumeResourceUpdate.

type VolumeSecretEncodings 

type VolumeSecretEncodings string

VolumeSecretEncodings - Encoding format. Default utf-8 

const (
	// VolumeSecretEncodingsBase64 - Base64 encoding
	VolumeSecretEncodingsBase64 VolumeSecretEncodings = "base64"
	// VolumeSecretEncodingsHex - Hex encoding
	VolumeSecretEncodingsHex VolumeSecretEncodings = "hex"
	// VolumeSecretEncodingsUTF8 - UTF-8 encoding
	VolumeSecretEncodingsUTF8 VolumeSecretEncodings = "utf-8"
)

func PossibleVolumeSecretEncodingsValues 

func PossibleVolumeSecretEncodingsValues() []VolumeSecretEncodings

PossibleVolumeSecretEncodingsValues returns the possible values for the VolumeSecretEncodings const type.

type VolumesClient 

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

VolumesClient contains the methods for the Volumes group. Don't use this type directly, use NewVolumesClient() instead.

func NewVolumesClient 

func NewVolumesClient(rootScope string, credential azcore.TokenCredential, options *arm.ClientOptions) (*VolumesClient, error)

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

func (client *VolumesClient) BeginCreateOrUpdate(ctx context.Context, volumeName string, resource VolumeResource, options *VolumesClientBeginCreateOrUpdateOptions) (*runtime.Poller[VolumesClientCreateOrUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • volumeName - Volume name
  • resource - Resource create parameters.
  • options - VolumesClientBeginCreateOrUpdateOptions contains the optional parameters for the VolumesClient.BeginCreateOrUpdate method.

func (*VolumesClient) BeginDelete 

func (client *VolumesClient) BeginDelete(ctx context.Context, volumeName string, options *VolumesClientBeginDeleteOptions) (*runtime.Poller[VolumesClientDeleteResponse], error)

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

Generated from API version 2023-10-01-preview

  • volumeName - Volume name
  • options - VolumesClientBeginDeleteOptions contains the optional parameters for the VolumesClient.BeginDelete method.

func (*VolumesClient) BeginUpdate 

func (client *VolumesClient) BeginUpdate(ctx context.Context, volumeName string, properties VolumeResourceUpdate, options *VolumesClientBeginUpdateOptions) (*runtime.Poller[VolumesClientUpdateResponse], error)

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

Generated from API version 2023-10-01-preview

  • volumeName - Volume name
  • properties - The resource properties to be updated.
  • options - VolumesClientBeginUpdateOptions contains the optional parameters for the VolumesClient.BeginUpdate method.

func (*VolumesClient) Get 

func (client *VolumesClient) Get(ctx context.Context, volumeName string, options *VolumesClientGetOptions) (VolumesClientGetResponse, error)

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

Generated from API version 2023-10-01-preview

  • volumeName - Volume name
  • options - VolumesClientGetOptions contains the optional parameters for the VolumesClient.Get method.

func (*VolumesClient) NewListByScopePager 

func (client *VolumesClient) NewListByScopePager(options *VolumesClientListByScopeOptions) *runtime.Pager[VolumesClientListByScopeResponse]

NewListByScopePager - List VolumeResource resources by Scope

Generated from API version 2023-10-01-preview

  • options - VolumesClientListByScopeOptions contains the optional parameters for the VolumesClient.NewListByScopePager method.

type VolumesClientBeginCreateOrUpdateOptions 

type VolumesClientBeginCreateOrUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

VolumesClientBeginCreateOrUpdateOptions contains the optional parameters for the VolumesClient.BeginCreateOrUpdate method.

type VolumesClientBeginDeleteOptions 

type VolumesClientBeginDeleteOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

VolumesClientBeginDeleteOptions contains the optional parameters for the VolumesClient.BeginDelete method.

type VolumesClientBeginUpdateOptions 

type VolumesClientBeginUpdateOptions struct {
	// Resumes the long-running operation from the provided token.
	ResumeToken string
}

VolumesClientBeginUpdateOptions contains the optional parameters for the VolumesClient.BeginUpdate method.

type VolumesClientCreateOrUpdateResponse 

type VolumesClientCreateOrUpdateResponse struct {
	// Radius Volume resource.
	VolumeResource
}

VolumesClientCreateOrUpdateResponse contains the response from method VolumesClient.BeginCreateOrUpdate.

type VolumesClientDeleteResponse 

type VolumesClientDeleteResponse struct {
}

VolumesClientDeleteResponse contains the response from method VolumesClient.BeginDelete.

type VolumesClientGetOptions 

type VolumesClientGetOptions struct {
}

VolumesClientGetOptions contains the optional parameters for the VolumesClient.Get method.

type VolumesClientGetResponse 

type VolumesClientGetResponse struct {
	// Radius Volume resource.
	VolumeResource
}

VolumesClientGetResponse contains the response from method VolumesClient.Get.

type VolumesClientListByScopeOptions 

type VolumesClientListByScopeOptions struct {
}

VolumesClientListByScopeOptions contains the optional parameters for the VolumesClient.NewListByScopePager method.

type VolumesClientListByScopeResponse 

type VolumesClientListByScopeResponse struct {
	// The response of a VolumeResource list operation.
	VolumeResourceListResult
}

VolumesClientListByScopeResponse contains the response from method VolumesClient.NewListByScopePager.

type VolumesClientUpdateResponse 

type VolumesClientUpdateResponse struct {
	// Radius Volume resource.
	VolumeResource
}

VolumesClientUpdateResponse contains the response from method VolumesClient.BeginUpdate.

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.