1. Packages
  2. Azure Native v2
  3. API Docs
  4. azuresphere
  5. listCatalogDeployments
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

azure-native-v2.azuresphere.listCatalogDeployments

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

Lists deployments for catalog. Azure REST API version: 2022-09-01-preview.

Other available API versions: 2024-04-01.

Using listCatalogDeployments

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 listCatalogDeployments(args: ListCatalogDeploymentsArgs, opts?: InvokeOptions): Promise<ListCatalogDeploymentsResult>
function listCatalogDeploymentsOutput(args: ListCatalogDeploymentsOutputArgs, opts?: InvokeOptions): Output<ListCatalogDeploymentsResult>
Copy
def list_catalog_deployments(catalog_name: Optional[str] = None,
                             filter: Optional[str] = None,
                             maxpagesize: Optional[int] = None,
                             resource_group_name: Optional[str] = None,
                             skip: Optional[int] = None,
                             top: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> ListCatalogDeploymentsResult
def list_catalog_deployments_output(catalog_name: Optional[pulumi.Input[str]] = None,
                             filter: Optional[pulumi.Input[str]] = None,
                             maxpagesize: Optional[pulumi.Input[int]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             skip: Optional[pulumi.Input[int]] = None,
                             top: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[ListCatalogDeploymentsResult]
Copy
func ListCatalogDeployments(ctx *Context, args *ListCatalogDeploymentsArgs, opts ...InvokeOption) (*ListCatalogDeploymentsResult, error)
func ListCatalogDeploymentsOutput(ctx *Context, args *ListCatalogDeploymentsOutputArgs, opts ...InvokeOption) ListCatalogDeploymentsResultOutput
Copy

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

public static class ListCatalogDeployments 
{
    public static Task<ListCatalogDeploymentsResult> InvokeAsync(ListCatalogDeploymentsArgs args, InvokeOptions? opts = null)
    public static Output<ListCatalogDeploymentsResult> Invoke(ListCatalogDeploymentsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListCatalogDeploymentsResult> listCatalogDeployments(ListCatalogDeploymentsArgs args, InvokeOptions options)
public static Output<ListCatalogDeploymentsResult> listCatalogDeployments(ListCatalogDeploymentsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azuresphere:listCatalogDeployments
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Filter string
Filter the result list using the given expression
Maxpagesize int
The maximum number of result items per page.
Skip int
The number of result items to skip.
Top int
The number of result items to return.
CatalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
Filter string
Filter the result list using the given expression
Maxpagesize int
The maximum number of result items per page.
Skip int
The number of result items to skip.
Top int
The number of result items to return.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
filter String
Filter the result list using the given expression
maxpagesize Integer
The maximum number of result items per page.
skip Integer
The number of result items to skip.
top Integer
The number of result items to return.
catalogName
This property is required.
Changes to this property will trigger replacement.
string
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
filter string
Filter the result list using the given expression
maxpagesize number
The maximum number of result items per page.
skip number
The number of result items to skip.
top number
The number of result items to return.
catalog_name
This property is required.
Changes to this property will trigger replacement.
str
Name of catalog
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
filter str
Filter the result list using the given expression
maxpagesize int
The maximum number of result items per page.
skip int
The number of result items to skip.
top int
The number of result items to return.
catalogName
This property is required.
Changes to this property will trigger replacement.
String
Name of catalog
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
filter String
Filter the result list using the given expression
maxpagesize Number
The maximum number of result items per page.
skip Number
The number of result items to skip.
top Number
The number of result items to return.

listCatalogDeployments Result

The following output properties are available:

NextLink string
The link to the next page of items
Value List<Pulumi.AzureNative.AzureSphere.Outputs.DeploymentResponse>
The Deployment items on this page
NextLink string
The link to the next page of items
Value []DeploymentResponse
The Deployment items on this page
nextLink String
The link to the next page of items
value List<DeploymentResponse>
The Deployment items on this page
nextLink string
The link to the next page of items
value DeploymentResponse[]
The Deployment items on this page
next_link str
The link to the next page of items
value Sequence[DeploymentResponse]
The Deployment items on this page
nextLink String
The link to the next page of items
value List<Property Map>
The Deployment items on this page

Supporting Types

DeploymentResponse

DeploymentDateUtc This property is required. string
Deployment date UTC
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
ProvisioningState This property is required. string
The status of the last operation.
SystemData This property is required. Pulumi.AzureNative.AzureSphere.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DeployedImages List<Pulumi.AzureNative.AzureSphere.Inputs.ImageResponse>
Images deployed
DeploymentId string
Deployment ID
DeploymentDateUtc This property is required. string
Deployment date UTC
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
ProvisioningState This property is required. string
The status of the last operation.
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DeployedImages []ImageResponse
Images deployed
DeploymentId string
Deployment ID
deploymentDateUtc This property is required. String
Deployment date UTC
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
provisioningState This property is required. String
The status of the last operation.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deployedImages List<ImageResponse>
Images deployed
deploymentId String
Deployment ID
deploymentDateUtc This property is required. string
Deployment date UTC
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
provisioningState This property is required. string
The status of the last operation.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deployedImages ImageResponse[]
Images deployed
deploymentId string
Deployment ID
deployment_date_utc This property is required. str
Deployment date UTC
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
provisioning_state This property is required. str
The status of the last operation.
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deployed_images Sequence[ImageResponse]
Images deployed
deployment_id str
Deployment ID
deploymentDateUtc This property is required. String
Deployment date UTC
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
provisioningState This property is required. String
The status of the last operation.
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
deployedImages List<Property Map>
Images deployed
deploymentId String
Deployment ID

ImageResponse

ComponentId This property is required. string
The image component id.
Description This property is required. string
The image description.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ImageName This property is required. string
Image name
ImageType This property is required. string
The image type.
Name This property is required. string
The name of the resource
ProvisioningState This property is required. string
The status of the last operation.
SystemData This property is required. Pulumi.AzureNative.AzureSphere.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uri This property is required. 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 This property is required. string
The image component id.
Description This property is required. string
The image description.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
ImageName This property is required. string
Image name
ImageType This property is required. string
The image type.
Name This property is required. string
The name of the resource
ProvisioningState This property is required. string
The status of the last operation.
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Uri This property is required. 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 This property is required. String
The image component id.
description This property is required. String
The image description.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
imageName This property is required. String
Image name
imageType This property is required. String
The image type.
name This property is required. String
The name of the resource
provisioningState This property is required. String
The status of the last operation.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri This property is required. 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 This property is required. string
The image component id.
description This property is required. string
The image description.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
imageName This property is required. string
Image name
imageType This property is required. string
The image type.
name This property is required. string
The name of the resource
provisioningState This property is required. string
The status of the last operation.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri This property is required. 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 This property is required. str
The image component id.
description This property is required. str
The image description.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
image_name This property is required. str
Image name
image_type This property is required. str
The image type.
name This property is required. str
The name of the resource
provisioning_state This property is required. str
The status of the last operation.
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri This property is required. 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 This property is required. String
The image component id.
description This property is required. String
The image description.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
imageName This property is required. String
Image name
imageType This property is required. String
The image type.
name This property is required. String
The name of the resource
provisioningState This property is required. String
The status of the last operation.
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
uri This property is required. 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

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-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