1. Packages
  2. Azure Native
  3. API Docs
  4. datamigration
  5. getService
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.datamigration.getService

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The GET method retrieves information about a service instance.

Uses Azure REST API version 2023-07-15-preview.

Other available API versions: 2021-06-30, 2021-10-30-preview, 2022-01-30-preview, 2022-03-30-preview, 2025-03-15-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native datamigration [ApiVersion]. See the version guide for details.

Using getService

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 getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
Copy
def get_service(group_name: Optional[str] = None,
                service_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(group_name: Optional[pulumi.Input[str]] = None,
                service_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
Copy
func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput
Copy

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

public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:datamigration:getService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
GroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
groupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the service
groupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group
serviceName
This property is required.
Changes to this property will trigger replacement.
string
Name of the service
group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group
service_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the service
groupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Name of the service

getService Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Name string
ProvisioningState string
The resource's provisioning state
SystemData Pulumi.AzureNative.DataMigration.Outputs.SystemDataResponse
Type string
AutoStopDelay string
The time delay before the service is auto-stopped when idle.
DeleteResourcesOnStop bool
Whether service resources should be deleted when stopped. (Turned on by default)
Etag string
HTTP strong entity tag value. Ignored if submitted
Kind string
The resource kind. Only 'vm' (the default) is supported.
Location string
PublicKey string
The public key of the service, used to encrypt secrets sent to the service
Sku Pulumi.AzureNative.DataMigration.Outputs.ServiceSkuResponse
Service SKU
Tags Dictionary<string, string>
VirtualNicId string
The ID of the Microsoft.Network/networkInterfaces resource which the service have
VirtualSubnetId string
The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
AzureApiVersion string
The Azure API version of the resource.
Id string
Name string
ProvisioningState string
The resource's provisioning state
SystemData SystemDataResponse
Type string
AutoStopDelay string
The time delay before the service is auto-stopped when idle.
DeleteResourcesOnStop bool
Whether service resources should be deleted when stopped. (Turned on by default)
Etag string
HTTP strong entity tag value. Ignored if submitted
Kind string
The resource kind. Only 'vm' (the default) is supported.
Location string
PublicKey string
The public key of the service, used to encrypt secrets sent to the service
Sku ServiceSkuResponse
Service SKU
Tags map[string]string
VirtualNicId string
The ID of the Microsoft.Network/networkInterfaces resource which the service have
VirtualSubnetId string
The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
azureApiVersion String
The Azure API version of the resource.
id String
name String
provisioningState String
The resource's provisioning state
systemData SystemDataResponse
type String
autoStopDelay String
The time delay before the service is auto-stopped when idle.
deleteResourcesOnStop Boolean
Whether service resources should be deleted when stopped. (Turned on by default)
etag String
HTTP strong entity tag value. Ignored if submitted
kind String
The resource kind. Only 'vm' (the default) is supported.
location String
publicKey String
The public key of the service, used to encrypt secrets sent to the service
sku ServiceSkuResponse
Service SKU
tags Map<String,String>
virtualNicId String
The ID of the Microsoft.Network/networkInterfaces resource which the service have
virtualSubnetId String
The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
azureApiVersion string
The Azure API version of the resource.
id string
name string
provisioningState string
The resource's provisioning state
systemData SystemDataResponse
type string
autoStopDelay string
The time delay before the service is auto-stopped when idle.
deleteResourcesOnStop boolean
Whether service resources should be deleted when stopped. (Turned on by default)
etag string
HTTP strong entity tag value. Ignored if submitted
kind string
The resource kind. Only 'vm' (the default) is supported.
location string
publicKey string
The public key of the service, used to encrypt secrets sent to the service
sku ServiceSkuResponse
Service SKU
tags {[key: string]: string}
virtualNicId string
The ID of the Microsoft.Network/networkInterfaces resource which the service have
virtualSubnetId string
The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
azure_api_version str
The Azure API version of the resource.
id str
name str
provisioning_state str
The resource's provisioning state
system_data SystemDataResponse
type str
auto_stop_delay str
The time delay before the service is auto-stopped when idle.
delete_resources_on_stop bool
Whether service resources should be deleted when stopped. (Turned on by default)
etag str
HTTP strong entity tag value. Ignored if submitted
kind str
The resource kind. Only 'vm' (the default) is supported.
location str
public_key str
The public key of the service, used to encrypt secrets sent to the service
sku ServiceSkuResponse
Service SKU
tags Mapping[str, str]
virtual_nic_id str
The ID of the Microsoft.Network/networkInterfaces resource which the service have
virtual_subnet_id str
The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
azureApiVersion String
The Azure API version of the resource.
id String
name String
provisioningState String
The resource's provisioning state
systemData Property Map
type String
autoStopDelay String
The time delay before the service is auto-stopped when idle.
deleteResourcesOnStop Boolean
Whether service resources should be deleted when stopped. (Turned on by default)
etag String
HTTP strong entity tag value. Ignored if submitted
kind String
The resource kind. Only 'vm' (the default) is supported.
location String
publicKey String
The public key of the service, used to encrypt secrets sent to the service
sku Property Map
Service SKU
tags Map<String>
virtualNicId String
The ID of the Microsoft.Network/networkInterfaces resource which the service have
virtualSubnetId String
The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined

Supporting Types

ServiceSkuResponse

Capacity int
The capacity of the SKU, if it supports scaling
Family string
The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
Name string
The unique name of the SKU, such as 'P3'
Size string
The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
Tier string
The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'
Capacity int
The capacity of the SKU, if it supports scaling
Family string
The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
Name string
The unique name of the SKU, such as 'P3'
Size string
The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
Tier string
The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'
capacity Integer
The capacity of the SKU, if it supports scaling
family String
The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
name String
The unique name of the SKU, such as 'P3'
size String
The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
tier String
The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'
capacity number
The capacity of the SKU, if it supports scaling
family string
The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
name string
The unique name of the SKU, such as 'P3'
size string
The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
tier string
The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'
capacity int
The capacity of the SKU, if it supports scaling
family str
The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
name str
The unique name of the SKU, such as 'P3'
size str
The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
tier str
The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'
capacity Number
The capacity of the SKU, if it supports scaling
family String
The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
name String
The unique name of the SKU, such as 'P3'
size String
The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
tier String
The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'

SystemDataResponse

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi