Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. azuresphere
  5. getImage
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.azuresphere.getImage

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get a Image Azure REST API version: 2022-09-01-preview.

    Other available API versions: 2024-04-01.

    Using getImage

    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 getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>
    def get_image(catalog_name: Optional[str] = None,
              image_name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(catalog_name: Optional[pulumi.Input[str]] = None,
              image_name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]
    func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

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

    public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:azuresphere:getImage
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CatalogName string
    Name of catalog
    ImageName string
    Image name. Use an image GUID for GA versions of the API.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    CatalogName string
    Name of catalog
    ImageName string
    Image name. Use an image GUID for GA versions of the API.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    catalogName String
    Name of catalog
    imageName String
    Image name. Use an image GUID for GA versions of the API.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    catalogName string
    Name of catalog
    imageName string
    Image name. Use an image GUID for GA versions of the API.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    catalog_name str
    Name of catalog
    image_name str
    Image name. Use an image GUID for GA versions of the API.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    catalogName String
    Name of catalog
    imageName String
    Image name. Use an image GUID for GA versions of the API.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getImage Result

    The following output properties are available:

    ComponentId string
    The image component id.
    Description string
    The image description.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ImageName string
    Image name
    ImageType string
    The image type.
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData Pulumi.AzureNative.AzureSphere.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Uri string
    Location the image
    Image string
    Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
    ImageId string
    Image ID
    RegionalDataBoundary string
    Regional data boundary for an image
    ComponentId string
    The image component id.
    Description string
    The image description.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    ImageName string
    Image name
    ImageType string
    The image type.
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Uri string
    Location the image
    Image string
    Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
    ImageId string
    Image ID
    RegionalDataBoundary string
    Regional data boundary for an image
    componentId String
    The image component id.
    description String
    The image description.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    imageName String
    Image name
    imageType String
    The image type.
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uri String
    Location the image
    image String
    Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
    imageId String
    Image ID
    regionalDataBoundary String
    Regional data boundary for an image
    componentId string
    The image component id.
    description string
    The image description.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    imageName string
    Image name
    imageType string
    The image type.
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uri string
    Location the image
    image string
    Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
    imageId string
    Image ID
    regionalDataBoundary string
    Regional data boundary for an image
    component_id str
    The image component id.
    description str
    The image description.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    image_name str
    Image name
    image_type str
    The image type.
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uri str
    Location the image
    image str
    Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
    image_id str
    Image ID
    regional_data_boundary str
    Regional data boundary for an image
    componentId String
    The image component id.
    description String
    The image description.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    imageName String
    Image name
    imageType String
    The image type.
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    uri String
    Location the image
    image String
    Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.
    imageId String
    Image ID
    regionalDataBoundary String
    Regional data boundary for an image

    Supporting Types

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native