Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. azurestack
  5. getProducts
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.azurestack.getProducts

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Returns a list of products. Azure REST API version: 2022-06-01.

Other available API versions: 2020-06-01-preview.

Using getProducts

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 getProducts(args: GetProductsArgs, opts?: InvokeOptions): Promise<GetProductsResult>
function getProductsOutput(args: GetProductsOutputArgs, opts?: InvokeOptions): Output<GetProductsResult>
Copy
def get_products(product_name: Optional[str] = None,
                 registration_name: Optional[str] = None,
                 resource_group: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetProductsResult
def get_products_output(product_name: Optional[pulumi.Input[str]] = None,
                 registration_name: Optional[pulumi.Input[str]] = None,
                 resource_group: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetProductsResult]
Copy
func GetProducts(ctx *Context, args *GetProductsArgs, opts ...InvokeOption) (*GetProductsResult, error)
func GetProductsOutput(ctx *Context, args *GetProductsOutputArgs, opts ...InvokeOption) GetProductsResultOutput
Copy

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

public static class GetProducts 
{
    public static Task<GetProductsResult> InvokeAsync(GetProductsArgs args, InvokeOptions? opts = null)
    public static Output<GetProductsResult> Invoke(GetProductsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProductsResult> getProducts(GetProductsArgs args, InvokeOptions options)
public static Output<GetProductsResult> getProducts(GetProductsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azurestack:getProducts
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProductName
This property is required.
Changes to this property will trigger replacement.
string
Name of the product.
RegistrationName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Stack registration.
ResourceGroup
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group.
ProductName
This property is required.
Changes to this property will trigger replacement.
string
Name of the product.
RegistrationName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Stack registration.
ResourceGroup
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group.
productName
This property is required.
Changes to this property will trigger replacement.
String
Name of the product.
registrationName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Stack registration.
resourceGroup
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group.
productName
This property is required.
Changes to this property will trigger replacement.
string
Name of the product.
registrationName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Azure Stack registration.
resourceGroup
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group.
product_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the product.
registration_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Azure Stack registration.
resource_group
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group.
productName
This property is required.
Changes to this property will trigger replacement.
String
Name of the product.
registrationName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Azure Stack registration.
resourceGroup
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group.

getProducts Result

The following output properties are available:

NextLink string
URI to the next page.
Value []ProductResponse
List of products.
nextLink String
URI to the next page.
value List<ProductResponse>
List of products.
nextLink string
URI to the next page.
value ProductResponse[]
List of products.
next_link str
URI to the next page.
value Sequence[ProductResponse]
List of products.
nextLink String
URI to the next page.
value List<Property Map>
List of products.

Supporting Types

CompatibilityResponse

Description string
Full error message if any compatibility issues are found
IsCompatible bool
Tells if product is compatible with current device
Issues List<string>
List of all issues found
Message string
Short error message if any compatibility issues are found
Description string
Full error message if any compatibility issues are found
IsCompatible bool
Tells if product is compatible with current device
Issues []string
List of all issues found
Message string
Short error message if any compatibility issues are found
description String
Full error message if any compatibility issues are found
isCompatible Boolean
Tells if product is compatible with current device
issues List<String>
List of all issues found
message String
Short error message if any compatibility issues are found
description string
Full error message if any compatibility issues are found
isCompatible boolean
Tells if product is compatible with current device
issues string[]
List of all issues found
message string
Short error message if any compatibility issues are found
description str
Full error message if any compatibility issues are found
is_compatible bool
Tells if product is compatible with current device
issues Sequence[str]
List of all issues found
message str
Short error message if any compatibility issues are found
description String
Full error message if any compatibility issues are found
isCompatible Boolean
Tells if product is compatible with current device
issues List<String>
List of all issues found
message String
Short error message if any compatibility issues are found

IconUrisResponse

Hero string
URI to hero icon.
Large string
URI to large icon.
Medium string
URI to medium icon.
Small string
URI to small icon.
Wide string
URI to wide icon.
Hero string
URI to hero icon.
Large string
URI to large icon.
Medium string
URI to medium icon.
Small string
URI to small icon.
Wide string
URI to wide icon.
hero String
URI to hero icon.
large String
URI to large icon.
medium String
URI to medium icon.
small String
URI to small icon.
wide String
URI to wide icon.
hero string
URI to hero icon.
large string
URI to large icon.
medium string
URI to medium icon.
small string
URI to small icon.
wide string
URI to wide icon.
hero str
URI to hero icon.
large str
URI to large icon.
medium str
URI to medium icon.
small str
URI to small icon.
wide str
URI to wide icon.
hero String
URI to hero icon.
large String
URI to large icon.
medium String
URI to medium icon.
small String
URI to small icon.
wide String
URI to wide icon.

ProductLinkResponse

DisplayName string
The description of the link.
Uri string
The URI corresponding to the link.
DisplayName string
The description of the link.
Uri string
The URI corresponding to the link.
displayName String
The description of the link.
uri String
The URI corresponding to the link.
displayName string
The description of the link.
uri string
The URI corresponding to the link.
display_name str
The description of the link.
uri str
The URI corresponding to the link.
displayName String
The description of the link.
uri String
The URI corresponding to the link.

ProductPropertiesResponse

Version string
The version.
Version string
The version.
version String
The version.
version string
The version.
version str
The version.
version String
The version.

ProductResponse

Id This property is required. string
ID of the resource.
Name This property is required. string
Name of the resource.
Type This property is required. string
Type of Resource.
BillingPartNumber string
The part number used for billing purposes.
Compatibility Pulumi.AzureNative.AzureStack.Inputs.CompatibilityResponse
Product compatibility with current device.
Description string
The description of the product.
DisplayName string
The display name of the product.
Etag string
The entity tag used for optimistic concurrency when modifying the resource.
GalleryItemIdentity string
The identifier of the gallery item corresponding to the product.
IconUris Pulumi.AzureNative.AzureStack.Inputs.IconUrisResponse
Additional links available for this product.
LegalTerms string
The legal terms.
Links List<Pulumi.AzureNative.AzureStack.Inputs.ProductLinkResponse>
Additional links available for this product.
Offer string
The offer representing the product.
OfferVersion string
The version of the product offer.
PayloadLength double
The length of product content.
PrivacyPolicy string
The privacy policy.
ProductKind string
The kind of the product (virtualMachine or virtualMachineExtension)
ProductProperties Pulumi.AzureNative.AzureStack.Inputs.ProductPropertiesResponse
Additional properties for the product.
PublisherDisplayName string
The user-friendly name of the product publisher.
PublisherIdentifier string
Publisher identifier.
Sku string
The product SKU.
VmExtensionType string
The type of the Virtual Machine Extension.
Id This property is required. string
ID of the resource.
Name This property is required. string
Name of the resource.
Type This property is required. string
Type of Resource.
BillingPartNumber string
The part number used for billing purposes.
Compatibility CompatibilityResponse
Product compatibility with current device.
Description string
The description of the product.
DisplayName string
The display name of the product.
Etag string
The entity tag used for optimistic concurrency when modifying the resource.
GalleryItemIdentity string
The identifier of the gallery item corresponding to the product.
IconUris IconUrisResponse
Additional links available for this product.
LegalTerms string
The legal terms.
Links []ProductLinkResponse
Additional links available for this product.
Offer string
The offer representing the product.
OfferVersion string
The version of the product offer.
PayloadLength float64
The length of product content.
PrivacyPolicy string
The privacy policy.
ProductKind string
The kind of the product (virtualMachine or virtualMachineExtension)
ProductProperties ProductPropertiesResponse
Additional properties for the product.
PublisherDisplayName string
The user-friendly name of the product publisher.
PublisherIdentifier string
Publisher identifier.
Sku string
The product SKU.
VmExtensionType string
The type of the Virtual Machine Extension.
id This property is required. String
ID of the resource.
name This property is required. String
Name of the resource.
type This property is required. String
Type of Resource.
billingPartNumber String
The part number used for billing purposes.
compatibility CompatibilityResponse
Product compatibility with current device.
description String
The description of the product.
displayName String
The display name of the product.
etag String
The entity tag used for optimistic concurrency when modifying the resource.
galleryItemIdentity String
The identifier of the gallery item corresponding to the product.
iconUris IconUrisResponse
Additional links available for this product.
legalTerms String
The legal terms.
links List<ProductLinkResponse>
Additional links available for this product.
offer String
The offer representing the product.
offerVersion String
The version of the product offer.
payloadLength Double
The length of product content.
privacyPolicy String
The privacy policy.
productKind String
The kind of the product (virtualMachine or virtualMachineExtension)
productProperties ProductPropertiesResponse
Additional properties for the product.
publisherDisplayName String
The user-friendly name of the product publisher.
publisherIdentifier String
Publisher identifier.
sku String
The product SKU.
vmExtensionType String
The type of the Virtual Machine Extension.
id This property is required. string
ID of the resource.
name This property is required. string
Name of the resource.
type This property is required. string
Type of Resource.
billingPartNumber string
The part number used for billing purposes.
compatibility CompatibilityResponse
Product compatibility with current device.
description string
The description of the product.
displayName string
The display name of the product.
etag string
The entity tag used for optimistic concurrency when modifying the resource.
galleryItemIdentity string
The identifier of the gallery item corresponding to the product.
iconUris IconUrisResponse
Additional links available for this product.
legalTerms string
The legal terms.
links ProductLinkResponse[]
Additional links available for this product.
offer string
The offer representing the product.
offerVersion string
The version of the product offer.
payloadLength number
The length of product content.
privacyPolicy string
The privacy policy.
productKind string
The kind of the product (virtualMachine or virtualMachineExtension)
productProperties ProductPropertiesResponse
Additional properties for the product.
publisherDisplayName string
The user-friendly name of the product publisher.
publisherIdentifier string
Publisher identifier.
sku string
The product SKU.
vmExtensionType string
The type of the Virtual Machine Extension.
id This property is required. str
ID of the resource.
name This property is required. str
Name of the resource.
type This property is required. str
Type of Resource.
billing_part_number str
The part number used for billing purposes.
compatibility CompatibilityResponse
Product compatibility with current device.
description str
The description of the product.
display_name str
The display name of the product.
etag str
The entity tag used for optimistic concurrency when modifying the resource.
gallery_item_identity str
The identifier of the gallery item corresponding to the product.
icon_uris IconUrisResponse
Additional links available for this product.
legal_terms str
The legal terms.
links Sequence[ProductLinkResponse]
Additional links available for this product.
offer str
The offer representing the product.
offer_version str
The version of the product offer.
payload_length float
The length of product content.
privacy_policy str
The privacy policy.
product_kind str
The kind of the product (virtualMachine or virtualMachineExtension)
product_properties ProductPropertiesResponse
Additional properties for the product.
publisher_display_name str
The user-friendly name of the product publisher.
publisher_identifier str
Publisher identifier.
sku str
The product SKU.
vm_extension_type str
The type of the Virtual Machine Extension.
id This property is required. String
ID of the resource.
name This property is required. String
Name of the resource.
type This property is required. String
Type of Resource.
billingPartNumber String
The part number used for billing purposes.
compatibility Property Map
Product compatibility with current device.
description String
The description of the product.
displayName String
The display name of the product.
etag String
The entity tag used for optimistic concurrency when modifying the resource.
galleryItemIdentity String
The identifier of the gallery item corresponding to the product.
iconUris Property Map
Additional links available for this product.
legalTerms String
The legal terms.
links List<Property Map>
Additional links available for this product.
offer String
The offer representing the product.
offerVersion String
The version of the product offer.
payloadLength Number
The length of product content.
privacyPolicy String
The privacy policy.
productKind String
The kind of the product (virtualMachine or virtualMachineExtension)
productProperties Property Map
Additional properties for the product.
publisherDisplayName String
The user-friendly name of the product publisher.
publisherIdentifier String
Publisher identifier.
sku String
The product SKU.
vmExtensionType String
The type of the Virtual Machine Extension.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native