Azure Native v1.99.1, Mar 31 23

azure-native.insights.getFavorite

Get a single favorite by its FavoriteId, defined within an Application Insights component. API Version: 2015-05-01.

Using getFavorite

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFavorite(args: GetFavoriteArgs, opts?: InvokeOptions): Promise<GetFavoriteResult>
function getFavoriteOutput(args: GetFavoriteOutputArgs, opts?: InvokeOptions): Output<GetFavoriteResult>

def get_favorite(favorite_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 resource_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetFavoriteResult
def get_favorite_output(favorite_id: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 resource_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetFavoriteResult]

func LookupFavorite(ctx *Context, args *LookupFavoriteArgs, opts ...InvokeOption) (*LookupFavoriteResult, error)
func LookupFavoriteOutput(ctx *Context, args *LookupFavoriteOutputArgs, opts ...InvokeOption) LookupFavoriteResultOutput

> Note: This function is named LookupFavorite in the Go SDK.

public static class GetFavorite 
{
    public static Task<GetFavoriteResult> InvokeAsync(GetFavoriteArgs args, InvokeOptions? opts = null)
    public static Output<GetFavoriteResult> Invoke(GetFavoriteInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFavoriteResult> getFavorite(GetFavoriteArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:insights:getFavorite
  arguments:
    # arguments dictionary

The following arguments are supported:

FavoriteId string: The Id of a specific favorite defined in the Application Insights component
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ResourceName string: The name of the Application Insights component resource.

FavoriteId string: The Id of a specific favorite defined in the Application Insights component
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ResourceName string: The name of the Application Insights component resource.

favoriteId String: The Id of a specific favorite defined in the Application Insights component
resourceGroupName String: The name of the resource group. The name is case insensitive.
resourceName String: The name of the Application Insights component resource.

favoriteId string: The Id of a specific favorite defined in the Application Insights component
resourceGroupName string: The name of the resource group. The name is case insensitive.
resourceName string: The name of the Application Insights component resource.

favorite_id str: The Id of a specific favorite defined in the Application Insights component
resource_group_name str: The name of the resource group. The name is case insensitive.
resource_name str: The name of the Application Insights component resource.

favoriteId String: The Id of a specific favorite defined in the Application Insights component
resourceGroupName String: The name of the resource group. The name is case insensitive.
resourceName String: The name of the Application Insights component resource.

getFavorite Result

The following output properties are available:

FavoriteId string: Internally assigned unique id of the favorite definition.
TimeModified string: Date and time in UTC of the last modification that was made to this favorite definition.
UserId string: Unique user id of the specific user that owns this favorite.
Category string: Favorite category, as defined by the user at creation time.
Config string: Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON
FavoriteType string: Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
IsGeneratedFromTemplate bool: Flag denoting wether or not this favorite was generated from a template.
Name string: The user-defined name of the favorite.
SourceType string: The source of the favorite definition.
Tags List<string>: A list of 0 or more tags that are associated with this favorite definition
Version string: This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

FavoriteId string: Internally assigned unique id of the favorite definition.
TimeModified string: Date and time in UTC of the last modification that was made to this favorite definition.
UserId string: Unique user id of the specific user that owns this favorite.
Category string: Favorite category, as defined by the user at creation time.
Config string: Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON
FavoriteType string: Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
IsGeneratedFromTemplate bool: Flag denoting wether or not this favorite was generated from a template.
Name string: The user-defined name of the favorite.
SourceType string: The source of the favorite definition.
Tags []string: A list of 0 or more tags that are associated with this favorite definition
Version string: This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

favoriteId String: Internally assigned unique id of the favorite definition.
timeModified String: Date and time in UTC of the last modification that was made to this favorite definition.
userId String: Unique user id of the specific user that owns this favorite.
category String: Favorite category, as defined by the user at creation time.
config String: Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON
favoriteType String: Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
isGeneratedFromTemplate Boolean: Flag denoting wether or not this favorite was generated from a template.
name String: The user-defined name of the favorite.
sourceType String: The source of the favorite definition.
tags List<String>: A list of 0 or more tags that are associated with this favorite definition
version String: This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

favoriteId string: Internally assigned unique id of the favorite definition.
timeModified string: Date and time in UTC of the last modification that was made to this favorite definition.
userId string: Unique user id of the specific user that owns this favorite.
category string: Favorite category, as defined by the user at creation time.
config string: Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON
favoriteType string: Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
isGeneratedFromTemplate boolean: Flag denoting wether or not this favorite was generated from a template.
name string: The user-defined name of the favorite.
sourceType string: The source of the favorite definition.
tags string[]: A list of 0 or more tags that are associated with this favorite definition
version string: This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

favorite_id str: Internally assigned unique id of the favorite definition.
time_modified str: Date and time in UTC of the last modification that was made to this favorite definition.
user_id str: Unique user id of the specific user that owns this favorite.
category str: Favorite category, as defined by the user at creation time.
config str: Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON
favorite_type str: Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
is_generated_from_template bool: Flag denoting wether or not this favorite was generated from a template.
name str: The user-defined name of the favorite.
source_type str: The source of the favorite definition.
tags Sequence[str]: A list of 0 or more tags that are associated with this favorite definition
version str: This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

favoriteId String: Internally assigned unique id of the favorite definition.
timeModified String: Date and time in UTC of the last modification that was made to this favorite definition.
userId String: Unique user id of the specific user that owns this favorite.
category String: Favorite category, as defined by the user at creation time.
config String: Configuration of this particular favorite, which are driven by the Azure portal UX. Configuration data is a string containing valid JSON
favoriteType String: Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.
isGeneratedFromTemplate Boolean: Flag denoting wether or not this favorite was generated from a template.
name String: The user-defined name of the favorite.
sourceType String: The source of the favorite definition.
tags List<String>: A list of 0 or more tags that are associated with this favorite definition
version String: This instance's version of the data model. This can change as new features are added that can be marked favorite. Current examples include MetricsExplorer (ME) and Search.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

azure-native.insights.getFavorite

Using getFavorite

getFavorite Result

Package Details

Contents