azure-native-v2.azuresphere.Deployment
Explore with Pulumi AI
An deployment resource belonging to a device group resource. Azure REST API version: 2022-09-01-preview. Prior API version in Azure Native 1.x: 2022-09-01-preview.
Other available API versions: 2024-04-01.
Create Deployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
args: DeploymentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Deployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
catalog_name: Optional[str] = None,
device_group_name: Optional[str] = None,
product_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
deployed_images: Optional[Sequence[ImageArgs]] = None,
deployment_id: Optional[str] = None,
deployment_name: Optional[str] = None)
func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)
public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)
public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)
type: azure-native:azuresphere:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DeploymentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. DeploymentArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DeploymentArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DeploymentArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. DeploymentArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampledeploymentResourceResourceFromAzuresphere = new AzureNative.Azuresphere.Deployment("exampledeploymentResourceResourceFromAzuresphere", new()
{
CatalogName = "string",
DeviceGroupName = "string",
ProductName = "string",
ResourceGroupName = "string",
DeployedImages = new[]
{
{
{ "image", "string" },
{ "imageId", "string" },
{ "regionalDataBoundary", "string" },
},
},
DeploymentId = "string",
DeploymentName = "string",
});
example, err := azuresphere.NewDeployment(ctx, "exampledeploymentResourceResourceFromAzuresphere", &azuresphere.DeploymentArgs{
CatalogName: "string",
DeviceGroupName: "string",
ProductName: "string",
ResourceGroupName: "string",
DeployedImages: []map[string]interface{}{
map[string]interface{}{
"image": "string",
"imageId": "string",
"regionalDataBoundary": "string",
},
},
DeploymentId: "string",
DeploymentName: "string",
})
var exampledeploymentResourceResourceFromAzuresphere = new Deployment("exampledeploymentResourceResourceFromAzuresphere", DeploymentArgs.builder()
.catalogName("string")
.deviceGroupName("string")
.productName("string")
.resourceGroupName("string")
.deployedImages(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.deploymentId("string")
.deploymentName("string")
.build());
exampledeployment_resource_resource_from_azuresphere = azure_native.azuresphere.Deployment("exampledeploymentResourceResourceFromAzuresphere",
catalog_name=string,
device_group_name=string,
product_name=string,
resource_group_name=string,
deployed_images=[{
image: string,
imageId: string,
regionalDataBoundary: string,
}],
deployment_id=string,
deployment_name=string)
const exampledeploymentResourceResourceFromAzuresphere = new azure_native.azuresphere.Deployment("exampledeploymentResourceResourceFromAzuresphere", {
catalogName: "string",
deviceGroupName: "string",
productName: "string",
resourceGroupName: "string",
deployedImages: [{
image: "string",
imageId: "string",
regionalDataBoundary: "string",
}],
deploymentId: "string",
deploymentName: "string",
});
type: azure-native:azuresphere:Deployment
properties:
catalogName: string
deployedImages:
- image: string
imageId: string
regionalDataBoundary: string
deploymentId: string
deploymentName: string
deviceGroupName: string
productName: string
resourceGroupName: string
Deployment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Deployment resource accepts the following input properties:
- Catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- 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.
- Deployed
Images Changes to this property will trigger replacement.
Azure Native. Azure Sphere. Inputs. Image> - Images deployed
- Deployment
Id Changes to this property will trigger replacement.
- Deployment ID
- Deployment
Name 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.
- Catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- 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.
- Deployed
Images Changes to this property will trigger replacement.
Type Args - Images deployed
- Deployment
Id Changes to this property will trigger replacement.
- Deployment ID
- Deployment
Name 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.
- catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- 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.
- deployed
Images Changes to this property will trigger replacement.
- Images deployed
- deployment
Id Changes to this property will trigger replacement.
- Deployment ID
- deployment
Name 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.
- catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- 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.
- deployed
Images Changes to this property will trigger replacement.
- Images deployed
- deployment
Id Changes to this property will trigger replacement.
- Deployment ID
- deployment
Name 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.
- catalog_
name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- 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.
- deployed_
images Changes to this property will trigger replacement.
Args] - Images deployed
- deployment_
id Changes to this property will trigger replacement.
- Deployment ID
- deployment_
name 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.
- catalog
Name This property is required. Changes to this property will trigger replacement.
- Name of catalog
- 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.
- deployed
Images Changes to this property will trigger replacement.
- Images deployed
- deployment
Id Changes to this property will trigger replacement.
- Deployment ID
- deployment
Name 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:
- Deployment
Date stringUtc - Deployment date UTC
- Id string
- The provider-assigned unique ID for this managed resource.
- 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"
- Deployment
Date stringUtc - Deployment date UTC
- Id string
- The provider-assigned unique ID for this managed resource.
- 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"
- deployment
Date StringUtc - Deployment date UTC
- id String
- The provider-assigned unique ID for this managed resource.
- 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"
- deployment
Date stringUtc - Deployment date UTC
- id string
- The provider-assigned unique ID for this managed resource.
- 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"
- deployment_
date_ strutc - Deployment date UTC
- id str
- The provider-assigned unique ID for this managed resource.
- 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"
- deployment
Date StringUtc - Deployment date UTC
- id String
- The provider-assigned unique ID for this managed resource.
- 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"
Supporting Types
Image, ImageArgs
- 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 string | Pulumi.Boundary Azure Native. Azure Sphere. Regional Data Boundary - Regional data boundary for an 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 string | RegionalBoundary Data Boundary - Regional data boundary for an 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 String | RegionalBoundary Data Boundary - Regional data boundary for an 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 string | RegionalBoundary Data Boundary - Regional data boundary for an 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_ str | Regionalboundary Data Boundary - Regional data boundary for an 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 String | "None" | "EU"Boundary - Regional data boundary for an image
ImageResponse, ImageResponseArgs
- 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
RegionalDataBoundary, RegionalDataBoundaryArgs
- None
- NoneNo data boundary
- EU
- EUEU data boundary
- Regional
Data Boundary None - NoneNo data boundary
- Regional
Data Boundary EU - EUEU data boundary
- None
- NoneNo data boundary
- EU
- EUEU data boundary
- None
- NoneNo data boundary
- EU
- EUEU data boundary
- NONE
- NoneNo data boundary
- EU
- EUEU data boundary
- "None"
- NoneNo data boundary
- "EU"
- EUEU data boundary
SystemDataResponse, SystemDataResponseArgs
- 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.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:azuresphere:Deployment MyDeployment1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0