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.getDeployment
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
Get a Deployment. ‘.default’ and ‘.unassigned’ are system defined values and cannot be used for product or device group name. Azure REST API version: 2022-09-01-preview.
Other available API versions: 2024-04-01.
Using getDeployment
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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
def get_deployment(catalog_name: Optional[str] = None,
deployment_name: Optional[str] = None,
device_group_name: Optional[str] = None,
product_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(catalog_name: Optional[pulumi.Input[str]] = None,
deployment_name: Optional[pulumi.Input[str]] = None,
device_group_name: Optional[pulumi.Input[str]] = None,
product_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput
> Note: This function is named LookupDeployment
in the Go SDK.
public static class GetDeployment
{
public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
public static Output<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:azuresphere:getDeployment
arguments:
# arguments dictionary
The following arguments are supported:
- Catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- Deployment
Name This property is required. Changes to this property will trigger replacement.
- Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- Device
Group Name This property is required. Changes to this property will trigger replacement.
- Name of device group.
- Product
Name This property is required. Changes to this property will trigger replacement.
- Name of product.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- Deployment
Name This property is required. Changes to this property will trigger replacement.
- Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- Device
Group Name This property is required. Changes to this property will trigger replacement.
- Name of device group.
- Product
Name This property is required. Changes to this property will trigger replacement.
- Name of product.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- deployment
Name This property is required. Changes to this property will trigger replacement.
- Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- device
Group Name This property is required. Changes to this property will trigger replacement.
- Name of device group.
- product
Name This property is required. Changes to this property will trigger replacement.
- Name of product.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- deployment
Name This property is required. Changes to this property will trigger replacement.
- Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- device
Group Name This property is required. Changes to this property will trigger replacement.
- Name of device group.
- product
Name This property is required. Changes to this property will trigger replacement.
- Name of product.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- catalog_
name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- deployment_
name This property is required. Changes to this property will trigger replacement.
- Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- device_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of device group.
- product_
name This property is required. Changes to this property will trigger replacement.
- Name of product.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- deployment
Name This property is required. Changes to this property will trigger replacement.
- Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.
- device
Group Name This property is required. Changes to this property will trigger replacement.
- Name of device group.
- product
Name This property is required. Changes to this property will trigger replacement.
- Name of product.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
getDeployment Result
The following output properties are available:
- Deployment
Date stringUtc - Deployment date UTC
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
- The name of the resource
- Provisioning
State string - The status of the last operation.
- System
Data Pulumi.Azure Native. Azure Sphere. Outputs. System Data Response - 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"
- Deployed
Images List<Pulumi.Azure Native. Azure Sphere. Outputs. Image Response> - Images deployed
- Deployment
Id string - Deployment ID
- Deployment
Date stringUtc - Deployment date UTC
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
- The name of the resource
- Provisioning
State string - The status of the last operation.
- System
Data SystemData Response - 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"
- Deployed
Images []ImageResponse - Images deployed
- Deployment
Id string - Deployment ID
- deployment
Date StringUtc - Deployment date UTC
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
- The name of the resource
- provisioning
State String - The status of the last operation.
- system
Data SystemData Response - 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"
- deployed
Images List<ImageResponse> - Images deployed
- deployment
Id String - Deployment ID
- deployment
Date stringUtc - Deployment date UTC
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name string
- The name of the resource
- provisioning
State string - The status of the last operation.
- system
Data SystemData Response - 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"
- deployed
Images ImageResponse[] - Images deployed
- deployment
Id string - Deployment ID
- deployment_
date_ strutc - Deployment date UTC
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name str
- The name of the resource
- provisioning_
state str - The status of the last operation.
- system_
data SystemData Response - 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"
- deployed_
images Sequence[ImageResponse] - Images deployed
- deployment_
id str - Deployment ID
- deployment
Date StringUtc - Deployment date UTC
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
- The name of the resource
- provisioning
State String - The status of the last operation.
- system
Data 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"
- deployed
Images List<Property Map> - Images deployed
- deployment
Id String - Deployment ID
Supporting Types
ImageResponse
- Component
Id 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}
- Image
Name This property is required. string - Image name
- Image
Type This property is required. string - The image type.
- Name
This property is required. string - The name of the resource
- Provisioning
State This property is required. string - The status of the last operation.
- System
Data This property is required. Pulumi.Azure Native. Azure Sphere. Inputs. System Data Response - 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.
- Image
Id string - Image ID
- Regional
Data stringBoundary - Regional data boundary for an image
- Component
Id 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}
- Image
Name This property is required. string - Image name
- Image
Type This property is required. string - The image type.
- Name
This property is required. string - The name of the resource
- Provisioning
State This property is required. string - The status of the last operation.
- System
Data This property is required. SystemData Response - 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.
- Image
Id string - Image ID
- Regional
Data stringBoundary - Regional data boundary for an image
- component
Id 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}
- image
Name This property is required. String - Image name
- image
Type This property is required. String - The image type.
- name
This property is required. String - The name of the resource
- provisioning
State This property is required. String - The status of the last operation.
- system
Data This property is required. SystemData Response - 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.
- image
Id String - Image ID
- regional
Data StringBoundary - Regional data boundary for an image
- component
Id 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}
- image
Name This property is required. string - Image name
- image
Type This property is required. string - The image type.
- name
This property is required. string - The name of the resource
- provisioning
State This property is required. string - The status of the last operation.
- system
Data This property is required. SystemData Response - 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.
- image
Id string - Image ID
- regional
Data stringBoundary - 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. SystemData Response - 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_ strboundary - Regional data boundary for an image
- component
Id 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}
- image
Name This property is required. String - Image name
- image
Type This property is required. String - The image type.
- name
This property is required. String - The name of the resource
- provisioning
State This property is required. String - The status of the last operation.
- system
Data 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.
- image
Id String - Image ID
- regional
Data StringBoundary - Regional data boundary for an image
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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