package
0.40.0
Repository: https://github.com/radius-project/radius.git
Documentation: pkg.go.dev

# Functions

NewApplicationsClient creates a new instance of ApplicationsClient with the specified values.
NewClientFactory creates a new instance of ClientFactory with the specified values.
NewContainersClient creates a new instance of ContainersClient with the specified values.
NewEnvironmentsClient creates a new instance of EnvironmentsClient with the specified values.
NewExtendersClient creates a new instance of ExtendersClient with the specified values.
NewGatewaysClient creates a new instance of GatewaysClient with the specified values.
NewOperationsClient creates a new instance of OperationsClient with the specified values.
NewSecretStoresClient creates a new instance of SecretStoresClient with the specified values.
NewVolumesClient creates a new instance of VolumesClient with the specified values.
PossibleActionTypeValues returns the possible values for the ActionType const type.
PossibleCertificateFormatsValues returns the possible values for the CertificateFormats const type.
PossibleCertificateTypesValues returns the possible values for the CertificateTypes const type.
PossibleContainerResourceProvisioningValues returns the possible values for the ContainerResourceProvisioning const type.
PossibleCreatedByTypeValues returns the possible values for the CreatedByType const type.
PossibleDaprSidecarExtensionProtocolValues returns the possible values for the DaprSidecarExtensionProtocol const type.
PossibleDirectionValues returns the possible values for the Direction const type.
PossibleIAMKindValues returns the possible values for the IAMKind const type.
PossibleIdentitySettingKindValues returns the possible values for the IdentitySettingKind const type.
PossibleImagePullPolicyValues returns the possible values for the ImagePullPolicy const type.
PossibleManagedStoreValues returns the possible values for the ManagedStore const type.
PossibleOriginValues returns the possible values for the Origin const type.
PossiblePortProtocolValues returns the possible values for the PortProtocol const type.
PossibleProvisioningStateValues returns the possible values for the ProvisioningState const type.
PossibleResourceProvisioningValues returns the possible values for the ResourceProvisioning const type.
PossibleRestartPolicyValues returns the possible values for the RestartPolicy const type.
PossibleSecretStoreDataTypeValues returns the possible values for the SecretStoreDataType const type.
PossibleSecretValueEncodingValues returns the possible values for the SecretValueEncoding const type.
PossibleTLSMinVersionValues returns the possible values for the TLSMinVersion const type.
PossibleVolumePermissionValues returns the possible values for the VolumePermission const type.
PossibleVolumeSecretEncodingsValues returns the possible values for the VolumeSecretEncodings const type.

# Constants

No description provided by the author
CertificateFormatsPem - PEM Certificate format.
CertificateFormatsPfx - PFX Certificate format.
CertificateTypesCertificate - Certificate type.
CertificateTypesPrivatekey - Private Key type.
CertificateTypesPublickey - Public Key type.
ContainerResourceProvisioningInternal - The resource lifecycle will be managed internally by Radius.
ContainerResourceProvisioningManual - The resource lifecycle will be managed by the user.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DaprSidecarExtensionProtocolGrpc - gRPC protocol.
DaprSidecarExtensionProtocolHTTP - HTTP protocol.
DirectionInbound - The resource defining this connection accepts inbound connections from the resource specified by this id.
DirectionOutbound - The resource defining this connection makes an outbound connection resource specified by this id.
No description provided by the author
IAMKindAzure - Azure Active Directory.
No description provided by the author
IdentitySettingKindAzureComWorkload - azure ad workload identity.
IdentitySettingKindUndefined - undefined identity.
ImagePullPolicyAlways - Always.
ImagePullPolicyIfNotPresent - IfNotPresent.
ImagePullPolicyNever - Never.
ManagedStoreDisk - Disk store.
ManagedStoreMemory - Memory store.
No description provided by the author
No description provided by the author
No description provided by the author
PortProtocolTCP - TCP protocol.
PortProtocolUDP - UDP protocol.
ProvisioningStateAccepted - The resource create request has been accepted.
ProvisioningStateCanceled - The resource provisioning has been canceled.
ProvisioningStateCreating - The resource is being created.
ProvisioningStateDeleting - The resource is being deleted.
ProvisioningStateFailed - The resource provisioning has failed.
ProvisioningStateProvisioning - The resource is being provisioned.
ProvisioningStateSucceeded - The resource has been successfully provisioned.
ProvisioningStateUpdating - The resource is being updated.
ResourceProvisioningManual - The resource lifecycle will be managed by the user.
ResourceProvisioningRecipe - The resource lifecycle will be managed by Radius.
RestartPolicyAlways - Always.
RestartPolicyNever - Never.
RestartPolicyOnFailure - OnFailure.
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'.
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'.
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'.
SecretStoreDataTypeCertificate - Certificate secret data type.
SecretStoreDataTypeGeneric - Generic secret data type.
SecretValueEncodingBase64 - The base64-encoded secret value.
SecretValueEncodingRaw - The raw secret value.
TLSMinVersionTls12 - TLS Version 1.2.
TLSMinVersionTls13 - TLS Version 1.3.
Version represents the api version in this package.
VolumePermissionRead - Read only.
VolumePermissionWrite - Read and write.
VolumeSecretEncodingsBase64 - Base64 encoding.
VolumeSecretEncodingsHex - Hex encoding.
VolumeSecretEncodingsUTF8 - UTF-8 encoding.

# Structs

ApplicationGraphConnection - Describes the connection between two resources.
ApplicationGraphOutputResource - Describes an output resource that comprises an application graph resource.
ApplicationGraphResource - Describes a resource in the application graph.
ApplicationGraphResponse - Describes the application architecture and its dependencies.
ApplicationProperties - Application properties.
ApplicationResource - Radius Application resource.
ApplicationResourceListResult - The response of a ApplicationResource list operation.
ApplicationResourceUpdate - Radius Application resource.
ApplicationsClient contains the methods for the Applications group.
ApplicationsClientCreateOrUpdateOptions contains the optional parameters for the ApplicationsClient.CreateOrUpdate method.
ApplicationsClientCreateOrUpdateResponse contains the response from method ApplicationsClient.CreateOrUpdate.
ApplicationsClientDeleteOptions contains the optional parameters for the ApplicationsClient.Delete method.
ApplicationsClientDeleteResponse contains the response from method ApplicationsClient.Delete.
ApplicationsClientGetGraphOptions contains the optional parameters for the ApplicationsClient.GetGraph method.
ApplicationsClientGetGraphResponse contains the response from method ApplicationsClient.GetGraph.
ApplicationsClientGetOptions contains the optional parameters for the ApplicationsClient.Get method.
ApplicationsClientGetResponse contains the response from method ApplicationsClient.Get.
ApplicationsClientListByScopeOptions contains the optional parameters for the ApplicationsClient.NewListByScopePager method.
ApplicationsClientListByScopeResponse contains the response from method ApplicationsClient.NewListByScopePager.
ApplicationsClientUpdateOptions contains the optional parameters for the ApplicationsClient.Update method.
ApplicationsClientUpdateResponse contains the response from method ApplicationsClient.Update.
AuthConfig - Authentication information used to access private Terraform module sources.
AzureKeyVaultVolumeProperties - Represents Azure Key Vault Volume properties.
AzureResourceManagerCommonTypesTrackedResourceUpdate - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'.
BicepConfigProperties - Configuration for Bicep Recipes.
BicepRecipeProperties - Represents Bicep recipe properties.
CertificateObjectProperties - Represents certificate object properties.
ClientFactory is a client factory used to create any client in this module.
ConnectionProperties - Connection Properties.
Container - Definition of a container.
ContainerPortProperties - Specifies a listening port for the container.
ContainerProperties - Container properties.
ContainerResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.
ContainerResourceListResult - The response of a ContainerResource list operation.
ContainerResourceUpdate - Concrete tracked resource types can be created by aliasing this type using a specific property type.
ContainersClient contains the methods for the Containers group.
ContainersClientBeginCreateOrUpdateOptions contains the optional parameters for the ContainersClient.BeginCreateOrUpdate method.
ContainersClientBeginDeleteOptions contains the optional parameters for the ContainersClient.BeginDelete method.
ContainersClientBeginUpdateOptions contains the optional parameters for the ContainersClient.BeginUpdate method.
ContainersClientCreateOrUpdateResponse contains the response from method ContainersClient.BeginCreateOrUpdate.
ContainersClientDeleteResponse contains the response from method ContainersClient.BeginDelete.
ContainersClientGetOptions contains the optional parameters for the ContainersClient.Get method.
ContainersClientGetResponse contains the response from method ContainersClient.Get.
ContainersClientListByScopeOptions contains the optional parameters for the ContainersClient.NewListByScopePager method.
ContainersClientListByScopeResponse contains the response from method ContainersClient.NewListByScopePager.
ContainersClientUpdateResponse contains the response from method ContainersClient.BeginUpdate.
DaprSidecarExtension - Specifies the resource should have a Dapr sidecar injected.
EnvironmentCompute - Represents backing compute resource.
EnvironmentProperties - Environment properties.
EnvironmentResource - The environment resource.
EnvironmentResourceListResult - The response of a EnvironmentResource list operation.
EnvironmentResourceUpdate - The environment resource.
EnvironmentsClient contains the methods for the Environments group.
EnvironmentsClientCreateOrUpdateOptions contains the optional parameters for the EnvironmentsClient.CreateOrUpdate method.
EnvironmentsClientCreateOrUpdateResponse contains the response from method EnvironmentsClient.CreateOrUpdate.
EnvironmentsClientDeleteOptions contains the optional parameters for the EnvironmentsClient.Delete method.
EnvironmentsClientDeleteResponse contains the response from method EnvironmentsClient.Delete.
EnvironmentsClientGetMetadataOptions contains the optional parameters for the EnvironmentsClient.GetMetadata method.
EnvironmentsClientGetMetadataResponse contains the response from method EnvironmentsClient.GetMetadata.
EnvironmentsClientGetOptions contains the optional parameters for the EnvironmentsClient.Get method.
EnvironmentsClientGetResponse contains the response from method EnvironmentsClient.Get.
EnvironmentsClientListByScopeOptions contains the optional parameters for the EnvironmentsClient.NewListByScopePager method.
EnvironmentsClientListByScopeResponse contains the response from method EnvironmentsClient.NewListByScopePager.
EnvironmentsClientUpdateOptions contains the optional parameters for the EnvironmentsClient.Update method.
EnvironmentsClientUpdateResponse contains the response from method EnvironmentsClient.Update.
EnvironmentVariable - Environment variables type.
EnvironmentVariableReference - The reference to the variable.
EphemeralVolume - Specifies an ephemeral volume for a container.
ErrorAdditionalInfo - The resource management error additional info.
ErrorDetail - The error detail.
ErrorResponse - Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExecHealthProbeProperties - Specifies the properties for readiness/liveness probe using an executable.
ExtenderProperties - ExtenderResource portable resource properties.
ExtenderResource portable resource.
ExtenderResourceListResult - The response of a ExtenderResource list operation.
ExtenderResourceUpdate - ExtenderResource portable resource.
ExtendersClient contains the methods for the Extenders group.
ExtendersClientBeginCreateOrUpdateOptions contains the optional parameters for the ExtendersClient.BeginCreateOrUpdate method.
ExtendersClientBeginDeleteOptions contains the optional parameters for the ExtendersClient.BeginDelete method.
ExtendersClientBeginUpdateOptions contains the optional parameters for the ExtendersClient.BeginUpdate method.
ExtendersClientCreateOrUpdateResponse contains the response from method ExtendersClient.BeginCreateOrUpdate.
ExtendersClientDeleteResponse contains the response from method ExtendersClient.BeginDelete.
ExtendersClientGetOptions contains the optional parameters for the ExtendersClient.Get method.
ExtendersClientGetResponse contains the response from method ExtendersClient.Get.
ExtendersClientListByScopeOptions contains the optional parameters for the ExtendersClient.NewListByScopePager method.
ExtendersClientListByScopeResponse contains the response from method ExtendersClient.NewListByScopePager.
ExtendersClientListSecretsOptions contains the optional parameters for the ExtendersClient.ListSecrets method.
ExtendersClientListSecretsResponse contains the response from method ExtendersClient.ListSecrets.
ExtendersClientUpdateResponse contains the response from method ExtendersClient.BeginUpdate.
Extension of a environment/application resource.
GatewayHostname - Declare hostname information for the Gateway.
GatewayProperties - Gateway properties.
GatewayResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.
GatewayResourceListResult - The response of a GatewayResource list operation.
GatewayResourceUpdate - Concrete tracked resource types can be created by aliasing this type using a specific property type.
GatewayRoute - Route attached to Gateway.
GatewaysClient contains the methods for the Gateways group.
GatewaysClientBeginCreateOptions contains the optional parameters for the GatewaysClient.BeginCreate method.
GatewaysClientBeginCreateOrUpdateOptions contains the optional parameters for the GatewaysClient.BeginCreateOrUpdate method.
GatewaysClientBeginDeleteOptions contains the optional parameters for the GatewaysClient.BeginDelete method.
GatewaysClientCreateOrUpdateResponse contains the response from method GatewaysClient.BeginCreateOrUpdate.
GatewaysClientCreateResponse contains the response from method GatewaysClient.BeginCreate.
GatewaysClientDeleteResponse contains the response from method GatewaysClient.BeginDelete.
GatewaysClientGetOptions contains the optional parameters for the GatewaysClient.Get method.
GatewaysClientGetResponse contains the response from method GatewaysClient.Get.
GatewaysClientListByScopeOptions contains the optional parameters for the GatewaysClient.NewListByScopePager method.
GatewaysClientListByScopeResponse contains the response from method GatewaysClient.NewListByScopePager.
GatewayTLS - TLS configuration definition for Gateway resource.
GitAuthConfig - Authentication information used to access private Terraform modules from Git repository sources.
HealthProbeProperties - Properties for readiness/liveness probe.
HTTPGetHealthProbeProperties - Specifies the properties for readiness/liveness probe using HTTP Get.
IamProperties - IAM properties.
IdentitySettings is the external identity setting.
KeyObjectProperties - Represents key object properties.
KubernetesCompute - The Kubernetes compute configuration.
KubernetesMetadataExtension - Kubernetes metadata extension of a environment/application resource.
KubernetesNamespaceExtension - Kubernetes namespace extension of a environment/application resource.
KubernetesRuntimeProperties - The runtime configuration properties for Kubernetes.
ManualScalingExtension - ManualScaling Extension.
Operation - Details of a REST API operation, returned from the Resource Provider Operations API.
OperationDisplay - Localized display information for this particular operation.
OperationListResult - A list of REST API operations supported by an Azure Resource Provider.
OperationsClient contains the methods for the Operations group.
OperationsClientListOptions contains the optional parameters for the OperationsClient.NewListPager method.
OperationsClientListResponse contains the response from method OperationsClient.NewListPager.
OutputResource - Properties of an output resource.
PersistentVolume - Specifies a persistent volume for a container.
ProviderConfigProperties - This configuration holds the necessary information to authenticate and interact with a provider for the recipe execution.
Providers - The Cloud providers configuration.
ProvidersAws - The AWS cloud provider definition.
ProvidersAzure - The Azure cloud provider definition.
Recipe - The recipe used to automatically deploy underlying infrastructure for a portable resource.
RecipeConfigProperties - Configuration for Recipes.
RecipeGetMetadata - Represents the request body of the getmetadata action.
RecipeGetMetadataResponse - The properties of a Recipe linked to an Environment.
RecipeProperties - Format of the template provided by the recipe.
RecipeStatus - Recipe status at deployment time for a resource.
RegistrySecretConfig - Registry Secret Configuration used to authenticate to private bicep registries.
Resource - Common fields that are returned in the response for all Azure Resource Manager resources.
ResourceReference - Describes a reference to an existing resource.
ResourceStatus - Status of a resource.
RuntimesProperties - The properties for runtime configuration.
SecretConfig - Personal Access Token (PAT) configuration used to authenticate to Git platforms.
SecretObjectProperties - Represents secret object properties.
SecretReference - This secret is used within a recipe.
SecretStoreListSecretsResult - The list of secrets.
SecretStoreProperties - The properties of SecretStore.
SecretStoreResource - Concrete tracked resource types can be created by aliasing this type using a specific property type.
SecretStoreResourceListResult - The response of a SecretStoreResource list operation.
SecretStoreResourceUpdate - Concrete tracked resource types can be created by aliasing this type using a specific property type.
SecretStoresClient contains the methods for the SecretStores group.
SecretStoresClientBeginCreateOrUpdateOptions contains the optional parameters for the SecretStoresClient.BeginCreateOrUpdate method.
SecretStoresClientBeginDeleteOptions contains the optional parameters for the SecretStoresClient.BeginDelete method.
SecretStoresClientBeginUpdateOptions contains the optional parameters for the SecretStoresClient.BeginUpdate method.
SecretStoresClientCreateOrUpdateResponse contains the response from method SecretStoresClient.BeginCreateOrUpdate.
SecretStoresClientDeleteResponse contains the response from method SecretStoresClient.BeginDelete.
SecretStoresClientGetOptions contains the optional parameters for the SecretStoresClient.Get method.
SecretStoresClientGetResponse contains the response from method SecretStoresClient.Get.
SecretStoresClientListByScopeOptions contains the optional parameters for the SecretStoresClient.NewListByScopePager method.
SecretStoresClientListByScopeResponse contains the response from method SecretStoresClient.NewListByScopePager.
SecretStoresClientListSecretsOptions contains the optional parameters for the SecretStoresClient.ListSecrets method.
SecretStoresClientListSecretsResponse contains the response from method SecretStoresClient.ListSecrets.
SecretStoresClientUpdateResponse contains the response from method SecretStoresClient.BeginUpdate.
SecretValueProperties - The properties of SecretValue.
SystemData - Metadata pertaining to creation and last modification of the resource.
TCPHealthProbeProperties - Specifies the properties for readiness/liveness probe using TCP.
TerraformConfigProperties - Configuration for Terraform Recipes.
TerraformRecipeProperties - Represents Terraform recipe properties.
TrackedResource - The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'.
ValueFromProperties - The Secret value source properties.
Volume - Specifies a volume for a container.
VolumeProperties - Volume properties.
VolumeResource - Radius Volume resource.
VolumeResourceListResult - The response of a VolumeResource list operation.
VolumeResourceUpdate - Radius Volume resource.
VolumesClient contains the methods for the Volumes group.
VolumesClientBeginCreateOrUpdateOptions contains the optional parameters for the VolumesClient.BeginCreateOrUpdate method.
VolumesClientBeginDeleteOptions contains the optional parameters for the VolumesClient.BeginDelete method.
VolumesClientBeginUpdateOptions contains the optional parameters for the VolumesClient.BeginUpdate method.
VolumesClientCreateOrUpdateResponse contains the response from method VolumesClient.BeginCreateOrUpdate.
VolumesClientDeleteResponse contains the response from method VolumesClient.BeginDelete.
VolumesClientGetOptions contains the optional parameters for the VolumesClient.Get method.
VolumesClientGetResponse contains the response from method VolumesClient.Get.
VolumesClientListByScopeOptions contains the optional parameters for the VolumesClient.NewListByScopePager method.
VolumesClientListByScopeResponse contains the response from method VolumesClient.NewListByScopePager.
VolumesClientUpdateResponse contains the response from method VolumesClient.BeginUpdate.

# Interfaces

EnvironmentComputeClassification provides polymorphic access to related types.
ExtensionClassification provides polymorphic access to related types.
HealthProbePropertiesClassification provides polymorphic access to related types.
RecipePropertiesClassification provides polymorphic access to related types.
VolumeClassification provides polymorphic access to related types.
VolumePropertiesClassification provides polymorphic access to related types.

# Type aliases

ActionType - Enum.
CertificateFormats - Represents certificate formats.
CertificateTypes - Represents certificate types.
ContainerResourceProvisioning - Specifies how the underlying service/resource is provisioned and managed.
CreatedByType - The type of identity that created the resource.
DaprSidecarExtensionProtocol - The Dapr sidecar extension protocol.
Direction - The direction of a connection.
IAMKind - The kind of IAM provider to configure.
IdentitySettingKind - IdentitySettingKind is the kind of supported external identity setting.
ImagePullPolicy - The image pull policy for the container.
ManagedStore - The managed store for the ephemeral volume.
Origin - The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX.
PortProtocol - The protocol in use by the port.
ProvisioningState - Provisioning state of the resource at the time the operation was called.
ResourceProvisioning - Specifies how the underlying service/resource is provisioned and managed.
RestartPolicy - Restart policy for the container.
SecretStoreDataType - The type of SecretStore data.
SecretValueEncoding - The type of SecretValue Encoding.
TLSMinVersion - TLS minimum protocol version (defaults to 1.2).
VolumePermission - The persistent volume permission.
VolumeSecretEncodings - Encoding format.