azure-native.migrate.MoveCollection
Explore with Pulumi AI
Define the move collection.
Uses Azure REST API version 2023-08-01. In version 2.x of the Azure Native provider, it used API version 2022-08-01.
Other available API versions: 2019-10-01-preview, 2021-01-01, 2021-08-01, 2022-08-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native migrate [ApiVersion]
. See the version guide for details.
Create MoveCollection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MoveCollection(name: string, args: MoveCollectionArgs, opts?: CustomResourceOptions);
@overload
def MoveCollection(resource_name: str,
args: MoveCollectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MoveCollection(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
identity: Optional[IdentityArgs] = None,
location: Optional[str] = None,
move_collection_name: Optional[str] = None,
properties: Optional[MoveCollectionPropertiesArgs] = None,
tags: Optional[Mapping[str, str]] = None)
func NewMoveCollection(ctx *Context, name string, args MoveCollectionArgs, opts ...ResourceOption) (*MoveCollection, error)
public MoveCollection(string name, MoveCollectionArgs args, CustomResourceOptions? opts = null)
public MoveCollection(String name, MoveCollectionArgs args)
public MoveCollection(String name, MoveCollectionArgs args, CustomResourceOptions options)
type: azure-native:migrate:MoveCollection
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. MoveCollectionArgs - 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. MoveCollectionArgs - 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. MoveCollectionArgs - 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. MoveCollectionArgs - 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. MoveCollectionArgs - 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 moveCollectionResource = new AzureNative.Migrate.MoveCollection("moveCollectionResource", new()
{
ResourceGroupName = "string",
Identity = new AzureNative.Migrate.Inputs.IdentityArgs
{
PrincipalId = "string",
TenantId = "string",
Type = "string",
},
Location = "string",
MoveCollectionName = "string",
Properties = new AzureNative.Migrate.Inputs.MoveCollectionPropertiesArgs
{
MoveRegion = "string",
MoveType = "string",
SourceRegion = "string",
TargetRegion = "string",
Version = "string",
},
Tags =
{
{ "string", "string" },
},
});
example, err := migrate.NewMoveCollection(ctx, "moveCollectionResource", &migrate.MoveCollectionArgs{
ResourceGroupName: pulumi.String("string"),
Identity: &migrate.IdentityArgs{
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
Type: pulumi.String("string"),
},
Location: pulumi.String("string"),
MoveCollectionName: pulumi.String("string"),
Properties: &migrate.MoveCollectionPropertiesArgs{
MoveRegion: pulumi.String("string"),
MoveType: pulumi.String("string"),
SourceRegion: pulumi.String("string"),
TargetRegion: pulumi.String("string"),
Version: pulumi.String("string"),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var moveCollectionResource = new MoveCollection("moveCollectionResource", MoveCollectionArgs.builder()
.resourceGroupName("string")
.identity(IdentityArgs.builder()
.principalId("string")
.tenantId("string")
.type("string")
.build())
.location("string")
.moveCollectionName("string")
.properties(MoveCollectionPropertiesArgs.builder()
.moveRegion("string")
.moveType("string")
.sourceRegion("string")
.targetRegion("string")
.version("string")
.build())
.tags(Map.of("string", "string"))
.build());
move_collection_resource = azure_native.migrate.MoveCollection("moveCollectionResource",
resource_group_name="string",
identity={
"principal_id": "string",
"tenant_id": "string",
"type": "string",
},
location="string",
move_collection_name="string",
properties={
"move_region": "string",
"move_type": "string",
"source_region": "string",
"target_region": "string",
"version": "string",
},
tags={
"string": "string",
})
const moveCollectionResource = new azure_native.migrate.MoveCollection("moveCollectionResource", {
resourceGroupName: "string",
identity: {
principalId: "string",
tenantId: "string",
type: "string",
},
location: "string",
moveCollectionName: "string",
properties: {
moveRegion: "string",
moveType: "string",
sourceRegion: "string",
targetRegion: "string",
version: "string",
},
tags: {
string: "string",
},
});
type: azure-native:migrate:MoveCollection
properties:
identity:
principalId: string
tenantId: string
type: string
location: string
moveCollectionName: string
properties:
moveRegion: string
moveType: string
sourceRegion: string
targetRegion: string
version: string
resourceGroupName: string
tags:
string: string
MoveCollection 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 MoveCollection resource accepts the following input properties:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- Identity
Pulumi.
Azure Native. Migrate. Inputs. Identity - Defines the MSI properties of the Move Collection.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives.
- Move
Collection Name Changes to this property will trigger replacement.
- The Move Collection Name.
- Properties
Pulumi.
Azure Native. Migrate. Inputs. Move Collection Properties - Defines the move collection properties.
- Dictionary<string, string>
- Resource tags.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- Identity
Identity
Args - Defines the MSI properties of the Move Collection.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives.
- Move
Collection Name Changes to this property will trigger replacement.
- The Move Collection Name.
- Properties
Move
Collection Properties Args - Defines the move collection properties.
- map[string]string
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- identity Identity
- Defines the MSI properties of the Move Collection.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives.
- move
Collection Name Changes to this property will trigger replacement.
- The Move Collection Name.
- properties
Move
Collection Properties - Defines the move collection properties.
- Map<String,String>
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- identity Identity
- Defines the MSI properties of the Move Collection.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives.
- move
Collection Name Changes to this property will trigger replacement.
- The Move Collection Name.
- properties
Move
Collection Properties - Defines the move collection properties.
- {[key: string]: string}
- Resource tags.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- identity
Identity
Args - Defines the MSI properties of the Move Collection.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives.
- move_
collection_ name Changes to this property will trigger replacement.
- The Move Collection Name.
- properties
Move
Collection Properties Args - Defines the move collection properties.
- Mapping[str, str]
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The Resource Group Name.
- identity Property Map
- Defines the MSI properties of the Move Collection.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives.
- move
Collection Name Changes to this property will trigger replacement.
- The Move Collection Name.
- properties Property Map
- Defines the move collection properties.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the MoveCollection resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- The etag of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Migrate. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource.
- Azure
Api stringVersion - The Azure API version of the resource.
- Etag string
- The etag of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The type of the resource.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- The etag of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource.
- azure
Api stringVersion - The Azure API version of the resource.
- etag string
- The etag of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The type of the resource.
- azure_
api_ strversion - The Azure API version of the resource.
- etag str
- The etag of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the resource.
- azure
Api StringVersion - The Azure API version of the resource.
- etag String
- The etag of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The type of the resource.
Supporting Types
Identity, IdentityArgs
- Principal
Id string - Gets or sets the principal id.
- Tenant
Id string - Gets or sets the tenant id.
- Type
string | Pulumi.
Azure Native. Migrate. Resource Identity Type - The type of identity used for the resource mover service.
- Principal
Id string - Gets or sets the principal id.
- Tenant
Id string - Gets or sets the tenant id.
- Type
string | Resource
Identity Type - The type of identity used for the resource mover service.
- principal
Id String - Gets or sets the principal id.
- tenant
Id String - Gets or sets the tenant id.
- type
String | Resource
Identity Type - The type of identity used for the resource mover service.
- principal
Id string - Gets or sets the principal id.
- tenant
Id string - Gets or sets the tenant id.
- type
string | Resource
Identity Type - The type of identity used for the resource mover service.
- principal_
id str - Gets or sets the principal id.
- tenant_
id str - Gets or sets the tenant id.
- type
str | Resource
Identity Type - The type of identity used for the resource mover service.
- principal
Id String - Gets or sets the principal id.
- tenant
Id String - Gets or sets the tenant id.
- type
String | "None" | "System
Assigned" | "User Assigned" - The type of identity used for the resource mover service.
IdentityResponse, IdentityResponseArgs
- Principal
Id string - Gets or sets the principal id.
- Tenant
Id string - Gets or sets the tenant id.
- Type string
- The type of identity used for the resource mover service.
- Principal
Id string - Gets or sets the principal id.
- Tenant
Id string - Gets or sets the tenant id.
- Type string
- The type of identity used for the resource mover service.
- principal
Id String - Gets or sets the principal id.
- tenant
Id String - Gets or sets the tenant id.
- type String
- The type of identity used for the resource mover service.
- principal
Id string - Gets or sets the principal id.
- tenant
Id string - Gets or sets the tenant id.
- type string
- The type of identity used for the resource mover service.
- principal_
id str - Gets or sets the principal id.
- tenant_
id str - Gets or sets the tenant id.
- type str
- The type of identity used for the resource mover service.
- principal
Id String - Gets or sets the principal id.
- tenant
Id String - Gets or sets the tenant id.
- type String
- The type of identity used for the resource mover service.
MoveCollectionProperties, MoveCollectionPropertiesArgs
- Move
Region string - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- Move
Type string | Pulumi.Azure Native. Migrate. Move Type - Defines the MoveType.
- Source
Region string - Gets or sets the source region.
- Target
Region string - Gets or sets the target region.
- Version string
- Gets or sets the version of move collection.
- Move
Region string - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- Move
Type string | MoveType - Defines the MoveType.
- Source
Region string - Gets or sets the source region.
- Target
Region string - Gets or sets the target region.
- Version string
- Gets or sets the version of move collection.
- move
Region String - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move
Type String | MoveType - Defines the MoveType.
- source
Region String - Gets or sets the source region.
- target
Region String - Gets or sets the target region.
- version String
- Gets or sets the version of move collection.
- move
Region string - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move
Type string | MoveType - Defines the MoveType.
- source
Region string - Gets or sets the source region.
- target
Region string - Gets or sets the target region.
- version string
- Gets or sets the version of move collection.
- move_
region str - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move_
type str | MoveType - Defines the MoveType.
- source_
region str - Gets or sets the source region.
- target_
region str - Gets or sets the target region.
- version str
- Gets or sets the version of move collection.
- move
Region String - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move
Type String | "RegionTo Region" | "Region To Zone" - Defines the MoveType.
- source
Region String - Gets or sets the source region.
- target
Region String - Gets or sets the target region.
- version String
- Gets or sets the version of move collection.
MoveCollectionPropertiesResponse, MoveCollectionPropertiesResponseArgs
- Errors
This property is required. Pulumi.Azure Native. Migrate. Inputs. Move Collection Properties Response Errors - Defines the move collection errors.
- Provisioning
State This property is required. string - Defines the provisioning states.
- Move
Region string - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- Move
Type string - Defines the MoveType.
- Source
Region string - Gets or sets the source region.
- Target
Region string - Gets or sets the target region.
- Version string
- Gets or sets the version of move collection.
- Errors
This property is required. MoveCollection Properties Response Errors - Defines the move collection errors.
- Provisioning
State This property is required. string - Defines the provisioning states.
- Move
Region string - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- Move
Type string - Defines the MoveType.
- Source
Region string - Gets or sets the source region.
- Target
Region string - Gets or sets the target region.
- Version string
- Gets or sets the version of move collection.
- errors
This property is required. MoveCollection Properties Response Errors - Defines the move collection errors.
- provisioning
State This property is required. String - Defines the provisioning states.
- move
Region String - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move
Type String - Defines the MoveType.
- source
Region String - Gets or sets the source region.
- target
Region String - Gets or sets the target region.
- version String
- Gets or sets the version of move collection.
- errors
This property is required. MoveCollection Properties Response Errors - Defines the move collection errors.
- provisioning
State This property is required. string - Defines the provisioning states.
- move
Region string - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move
Type string - Defines the MoveType.
- source
Region string - Gets or sets the source region.
- target
Region string - Gets or sets the target region.
- version string
- Gets or sets the version of move collection.
- errors
This property is required. MoveCollection Properties Response Errors - Defines the move collection errors.
- provisioning_
state This property is required. str - Defines the provisioning states.
- move_
region str - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move_
type str - Defines the MoveType.
- source_
region str - Gets or sets the source region.
- target_
region str - Gets or sets the target region.
- version str
- Gets or sets the version of move collection.
- errors
This property is required. Property Map - Defines the move collection errors.
- provisioning
State This property is required. String - Defines the provisioning states.
- move
Region String - Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.
- move
Type String - Defines the MoveType.
- source
Region String - Gets or sets the source region.
- target
Region String - Gets or sets the target region.
- version String
- Gets or sets the version of move collection.
MoveCollectionPropertiesResponseErrors, MoveCollectionPropertiesResponseErrorsArgs
- Properties
Pulumi.
Azure Native. Migrate. Inputs. Move Resource Error Body Response - The move resource error body.
- Properties
Move
Resource Error Body Response - The move resource error body.
- properties
Move
Resource Error Body Response - The move resource error body.
- properties
Move
Resource Error Body Response - The move resource error body.
- properties
Move
Resource Error Body Response - The move resource error body.
- properties Property Map
- The move resource error body.
MoveResourceErrorBodyResponse, MoveResourceErrorBodyResponseArgs
- Code
This property is required. string - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
- Details
This property is required. List<Pulumi.Azure Native. Migrate. Inputs. Move Resource Error Body Response> - A list of additional details about the error.
- Message
This property is required. string - A message describing the error, intended to be suitable for display in a user interface.
- Target
This property is required. string - The target of the particular error. For example, the name of the property in error.
- Code
This property is required. string - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
- Details
This property is required. []MoveResource Error Body Response - A list of additional details about the error.
- Message
This property is required. string - A message describing the error, intended to be suitable for display in a user interface.
- Target
This property is required. string - The target of the particular error. For example, the name of the property in error.
- code
This property is required. String - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
- details
This property is required. List<MoveResource Error Body Response> - A list of additional details about the error.
- message
This property is required. String - A message describing the error, intended to be suitable for display in a user interface.
- target
This property is required. String - The target of the particular error. For example, the name of the property in error.
- code
This property is required. string - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
- details
This property is required. MoveResource Error Body Response[] - A list of additional details about the error.
- message
This property is required. string - A message describing the error, intended to be suitable for display in a user interface.
- target
This property is required. string - The target of the particular error. For example, the name of the property in error.
- code
This property is required. str - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
- details
This property is required. Sequence[MoveResource Error Body Response] - A list of additional details about the error.
- message
This property is required. str - A message describing the error, intended to be suitable for display in a user interface.
- target
This property is required. str - The target of the particular error. For example, the name of the property in error.
- code
This property is required. String - An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
- details
This property is required. List<Property Map> - A list of additional details about the error.
- message
This property is required. String - A message describing the error, intended to be suitable for display in a user interface.
- target
This property is required. String - The target of the particular error. For example, the name of the property in error.
MoveType, MoveTypeArgs
- Region
To Region - RegionToRegion
- Region
To Zone - RegionToZone
- Move
Type Region To Region - RegionToRegion
- Move
Type Region To Zone - RegionToZone
- Region
To Region - RegionToRegion
- Region
To Zone - RegionToZone
- Region
To Region - RegionToRegion
- Region
To Zone - RegionToZone
- REGION_TO_REGION
- RegionToRegion
- REGION_TO_ZONE
- RegionToZone
- "Region
To Region" - RegionToRegion
- "Region
To Zone" - RegionToZone
ResourceIdentityType, ResourceIdentityTypeArgs
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- Resource
Identity Type None - None
- Resource
Identity Type System Assigned - SystemAssigned
- Resource
Identity Type User Assigned - UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- None
- None
- System
Assigned - SystemAssigned
- User
Assigned - UserAssigned
- NONE
- None
- SYSTEM_ASSIGNED
- SystemAssigned
- USER_ASSIGNED
- UserAssigned
- "None"
- None
- "System
Assigned" - SystemAssigned
- "User
Assigned" - UserAssigned
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:migrate:MoveCollection movecollection1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0