AzureResource
Represents an Azure resource, as a marker interface for I's that can be deployed to an Azure resource group.
type AzureResource interface{}Methods
A marker interface declares no methods of its own in Go. Its functions are declared on the concrete types they apply to.
AsExisting( name any, options ...*AsExistingOptions,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.options...*AsExistingOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*AsExistingOptions argument.
ResourceGroup anyThe name of the existing resource group as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
AsExistingInResourceGroup( name any, resourceGroup any, subscription any,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.resourceGroup anyThe resource group containing the existing resource as a string or parameter resource.subscriptionanyThe subscription identifier containing the resource group as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
AsExistingInSubscription( name any, subscription any,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.subscriptionanyThe subscription identifier containing the resource as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
AsExistingInTenant(name any) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
ClearDefaultRoleAssignments() AzureResourceReturns
AzureResource The resource builder.
Returns a handle; failures surface later via Err().
GetBicepIdentifier GetBicepIdentifier() (string, error)Returns
(string, error) A valid Bicep identifier.
Returns (string, error).
IsExisting IsExisting() (bool, error)Returns
(bool, error) true if the resource is marked as existing; otherwise, false.
Returns (bool, error).
PublishAsConnectionString() AzureResourceReturns
AzureResource The resource builder.
Returns a handle; failures surface later via Err().
PublishAsExisting( name any, options ...*PublishAsExistingOptions,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.options...*PublishAsExistingOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*PublishAsExistingOptions argument.
ResourceGroup anyThe name of the existing resource group as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
PublishAsExistingInResourceGroup( name any, resourceGroup any, subscription any,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.resourceGroup anyThe resource group containing the existing resource as a string or parameter resource.subscriptionanyThe subscription identifier containing the resource group as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
PublishAsExistingInSubscription( name any, subscription any,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.subscriptionanyThe subscription identifier containing the resource as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
PublishAsExistingInTenant(name any) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
RunAsExisting( name any, options ...*RunAsExistingOptions,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.options...*RunAsExistingOptions Optional settings, described under Options.Options
Optional parameters are passed in a trailing options ...*RunAsExistingOptions argument.
ResourceGroup anyThe name of the existing resource group as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
RunAsExistingInResourceGroup( name any, resourceGroup any, subscription any,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.resourceGroup anyThe resource group containing the existing resource as a string or parameter resource.subscriptionanyThe subscription identifier containing the resource group as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
RunAsExistingInSubscription( name any, subscription any,) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.subscriptionanyThe subscription identifier containing the resource as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
RunAsExistingInTenant(name any) AzureResourceParameters
nameanyThe name of the existing resource as a string or parameter resource.Returns
AzureResource The resource builder with the existing resource annotation added.
Returns a handle; failures surface later via Err().
Applies to
This interface applies to the following types: