Azure Classic v5.38.0, Mar 21 23

azure.domainservices.getService

Gets information about an Active Directory Domain Service.

Supported Modes: At present this data source only supports User Forest mode and not Resource Forest mode. Read more about the different operation modes for this service.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.DomainServices.GetService.Invoke(new()
    {
        Name = "example-aadds",
        ResourceGroupName = "example-aadds-rg",
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/domainservices"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := domainservices.LookupService(ctx, &domainservices.LookupServiceArgs{
			Name:              "example-aadds",
			ResourceGroupName: "example-aadds-rg",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.domainservices.DomainservicesFunctions;
import com.pulumi.azure.domainservices.inputs.GetServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = DomainservicesFunctions.getService(GetServiceArgs.builder()
            .name("example-aadds")
            .resourceGroupName("example-aadds-rg")
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example = azure.domainservices.get_service(name="example-aadds",
    resource_group_name="example-aadds-rg")

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.domainservices.getService({
    name: "example-aadds",
    resourceGroupName: "example-aadds-rg",
});

variables:
  example:
    fn::invoke:
      Function: azure:domainservices:getService
      Arguments:
        name: example-aadds
        resourceGroupName: example-aadds-rg

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>

def get_service(name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]

func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput

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

public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure:domainservices/getService:getService
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The display name for your managed Active Directory Domain Service resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Domain Service should exist. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

Name string: The display name for your managed Active Directory Domain Service resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the Resource Group in which the Domain Service should exist. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags assigned to the resource.

name String: The display name for your managed Active Directory Domain Service resource. Changing this forces a new resource to be created.
resourceGroupName String: The name of the Resource Group in which the Domain Service should exist. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags assigned to the resource.

name string: The display name for your managed Active Directory Domain Service resource. Changing this forces a new resource to be created.
resourceGroupName string: The name of the Resource Group in which the Domain Service should exist. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags assigned to the resource.

name str: The display name for your managed Active Directory Domain Service resource. Changing this forces a new resource to be created.
resource_group_name str: The name of the Resource Group in which the Domain Service should exist. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags assigned to the resource.

name String: The display name for your managed Active Directory Domain Service resource. Changing this forces a new resource to be created.
resourceGroupName String: The name of the Resource Group in which the Domain Service should exist. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags assigned to the resource.

getService Result

The following output properties are available:

DeploymentId string: A unique ID for the managed domain deployment.
DomainConfigurationType string: The forest type used by the managed domain. One of ResourceTrusting, for a Resource Forest, or blank, for a User Forest.
DomainName string: The Active Directory domain of the Domain Service. See official documentation for constraints and recommendations.
FilteredSyncEnabled bool: Whether group-based filtered sync (also called scoped synchronisation) is enabled.
Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure location in which the replica set resides.
Name string
Notifications List<GetServiceNotification>: A notifications block as defined below.
ReplicaSets List<GetServiceReplicaSet>: One or more replica_set blocks as defined below.
ResourceGroupName string
ResourceId string
SecureLdaps List<GetServiceSecureLdap>: A secure_ldap block as defined below.
Securities List<GetServiceSecurity>: A security block as defined below.
Sku string: The SKU of the Domain Service resource. One of Standard, Enterprise or Premium.
SyncOwner string
TenantId string
Version int
Tags Dictionary<string, string>: A mapping of tags assigned to the resource.

DeploymentId string: A unique ID for the managed domain deployment.
DomainConfigurationType string: The forest type used by the managed domain. One of ResourceTrusting, for a Resource Forest, or blank, for a User Forest.
DomainName string: The Active Directory domain of the Domain Service. See official documentation for constraints and recommendations.
FilteredSyncEnabled bool: Whether group-based filtered sync (also called scoped synchronisation) is enabled.
Id string: The provider-assigned unique ID for this managed resource.
Location string: The Azure location in which the replica set resides.
Name string
Notifications []GetServiceNotification: A notifications block as defined below.
ReplicaSets []GetServiceReplicaSet: One or more replica_set blocks as defined below.
ResourceGroupName string
ResourceId string
SecureLdaps []GetServiceSecureLdap: A secure_ldap block as defined below.
Securities []GetServiceSecurity: A security block as defined below.
Sku string: The SKU of the Domain Service resource. One of Standard, Enterprise or Premium.
SyncOwner string
TenantId string
Version int
Tags map[string]string: A mapping of tags assigned to the resource.

deploymentId String: A unique ID for the managed domain deployment.
domainConfigurationType String: The forest type used by the managed domain. One of ResourceTrusting, for a Resource Forest, or blank, for a User Forest.
domainName String: The Active Directory domain of the Domain Service. See official documentation for constraints and recommendations.
filteredSyncEnabled Boolean: Whether group-based filtered sync (also called scoped synchronisation) is enabled.
id String: The provider-assigned unique ID for this managed resource.
location String: The Azure location in which the replica set resides.
name String
notifications List<GetServiceNotification>: A notifications block as defined below.
replicaSets List<GetServiceReplicaSet>: One or more replica_set blocks as defined below.
resourceGroupName String
resourceId String
secureLdaps List<GetServiceSecureLdap>: A secure_ldap block as defined below.
securities List<GetServiceSecurity>: A security block as defined below.
sku String: The SKU of the Domain Service resource. One of Standard, Enterprise or Premium.
syncOwner String
tenantId String
version Integer
tags Map<String,String>: A mapping of tags assigned to the resource.

deploymentId string: A unique ID for the managed domain deployment.
domainConfigurationType string: The forest type used by the managed domain. One of ResourceTrusting, for a Resource Forest, or blank, for a User Forest.
domainName string: The Active Directory domain of the Domain Service. See official documentation for constraints and recommendations.
filteredSyncEnabled boolean: Whether group-based filtered sync (also called scoped synchronisation) is enabled.
id string: The provider-assigned unique ID for this managed resource.
location string: The Azure location in which the replica set resides.
name string
notifications GetServiceNotification[]: A notifications block as defined below.
replicaSets GetServiceReplicaSet[]: One or more replica_set blocks as defined below.
resourceGroupName string
resourceId string
secureLdaps GetServiceSecureLdap[]: A secure_ldap block as defined below.
securities GetServiceSecurity[]: A security block as defined below.
sku string: The SKU of the Domain Service resource. One of Standard, Enterprise or Premium.
syncOwner string
tenantId string
version number
tags {[key: string]: string}: A mapping of tags assigned to the resource.

deployment_id str: A unique ID for the managed domain deployment.
domain_configuration_type str: The forest type used by the managed domain. One of ResourceTrusting, for a Resource Forest, or blank, for a User Forest.
domain_name str: The Active Directory domain of the Domain Service. See official documentation for constraints and recommendations.
filtered_sync_enabled bool: Whether group-based filtered sync (also called scoped synchronisation) is enabled.
id str: The provider-assigned unique ID for this managed resource.
location str: The Azure location in which the replica set resides.
name str
notifications Sequence[GetServiceNotification]: A notifications block as defined below.
replica_sets Sequence[GetServiceReplicaSet]: One or more replica_set blocks as defined below.
resource_group_name str
resource_id str
secure_ldaps Sequence[GetServiceSecureLdap]: A secure_ldap block as defined below.
securities Sequence[GetServiceSecurity]: A security block as defined below.
sku str: The SKU of the Domain Service resource. One of Standard, Enterprise or Premium.
sync_owner str
tenant_id str
version int
tags Mapping[str, str]: A mapping of tags assigned to the resource.

deploymentId String: A unique ID for the managed domain deployment.
domainConfigurationType String: The forest type used by the managed domain. One of ResourceTrusting, for a Resource Forest, or blank, for a User Forest.
domainName String: The Active Directory domain of the Domain Service. See official documentation for constraints and recommendations.
filteredSyncEnabled Boolean: Whether group-based filtered sync (also called scoped synchronisation) is enabled.
id String: The provider-assigned unique ID for this managed resource.
location String: The Azure location in which the replica set resides.
name String
notifications List<Property Map>: A notifications block as defined below.
replicaSets List<Property Map>: One or more replica_set blocks as defined below.
resourceGroupName String
resourceId String
secureLdaps List<Property Map>: A secure_ldap block as defined below.
securities List<Property Map>: A security block as defined below.
sku String: The SKU of the Domain Service resource. One of Standard, Enterprise or Premium.
syncOwner String
tenantId String
version Number
tags Map<String>: A mapping of tags assigned to the resource.

Supporting Types

GetServiceNotification

AdditionalRecipients List<string>: A list of additional email addresses to notify when there are alerts in the managed domain.
NotifyDcAdmins bool: Whethermembers of the AAD DC Administrators group are notified when there are alerts in the managed domain.
NotifyGlobalAdmins bool: Whether all Global Administrators are notified when there are alerts in the managed domain.

AdditionalRecipients []string: A list of additional email addresses to notify when there are alerts in the managed domain.
NotifyDcAdmins bool: Whethermembers of the AAD DC Administrators group are notified when there are alerts in the managed domain.
NotifyGlobalAdmins bool: Whether all Global Administrators are notified when there are alerts in the managed domain.

additionalRecipients List<String>: A list of additional email addresses to notify when there are alerts in the managed domain.
notifyDcAdmins Boolean: Whethermembers of the AAD DC Administrators group are notified when there are alerts in the managed domain.
notifyGlobalAdmins Boolean: Whether all Global Administrators are notified when there are alerts in the managed domain.

additionalRecipients string[]: A list of additional email addresses to notify when there are alerts in the managed domain.
notifyDcAdmins boolean: Whethermembers of the AAD DC Administrators group are notified when there are alerts in the managed domain.
notifyGlobalAdmins boolean: Whether all Global Administrators are notified when there are alerts in the managed domain.

additional_recipients Sequence[str]: A list of additional email addresses to notify when there are alerts in the managed domain.
notify_dc_admins bool: Whethermembers of the AAD DC Administrators group are notified when there are alerts in the managed domain.
notify_global_admins bool: Whether all Global Administrators are notified when there are alerts in the managed domain.

additionalRecipients List<String>: A list of additional email addresses to notify when there are alerts in the managed domain.
notifyDcAdmins Boolean: Whethermembers of the AAD DC Administrators group are notified when there are alerts in the managed domain.
notifyGlobalAdmins Boolean: Whether all Global Administrators are notified when there are alerts in the managed domain.

GetServiceReplicaSet

DomainControllerIpAddresses List<string>: A list of subnet IP addresses for the domain controllers in the replica set, typically two.
ExternalAccessIpAddress string: The publicly routable IP address for the domain controllers in the replica set.
Id string: The ID of the Domain Service.
Location string: The Azure location in which the replica set resides.
ServiceStatus string: The current service status for the replica set.
SubnetId string: The ID of the subnet in which the replica set resides.

DomainControllerIpAddresses []string: A list of subnet IP addresses for the domain controllers in the replica set, typically two.
ExternalAccessIpAddress string: The publicly routable IP address for the domain controllers in the replica set.
Id string: The ID of the Domain Service.
Location string: The Azure location in which the replica set resides.
ServiceStatus string: The current service status for the replica set.
SubnetId string: The ID of the subnet in which the replica set resides.

domainControllerIpAddresses List<String>: A list of subnet IP addresses for the domain controllers in the replica set, typically two.
externalAccessIpAddress String: The publicly routable IP address for the domain controllers in the replica set.
id String: The ID of the Domain Service.
location String: The Azure location in which the replica set resides.
serviceStatus String: The current service status for the replica set.
subnetId String: The ID of the subnet in which the replica set resides.

domainControllerIpAddresses string[]: A list of subnet IP addresses for the domain controllers in the replica set, typically two.
externalAccessIpAddress string: The publicly routable IP address for the domain controllers in the replica set.
id string: The ID of the Domain Service.
location string: The Azure location in which the replica set resides.
serviceStatus string: The current service status for the replica set.
subnetId string: The ID of the subnet in which the replica set resides.

domain_controller_ip_addresses Sequence[str]: A list of subnet IP addresses for the domain controllers in the replica set, typically two.
external_access_ip_address str: The publicly routable IP address for the domain controllers in the replica set.
id str: The ID of the Domain Service.
location str: The Azure location in which the replica set resides.
service_status str: The current service status for the replica set.
subnet_id str: The ID of the subnet in which the replica set resides.

domainControllerIpAddresses List<String>: A list of subnet IP addresses for the domain controllers in the replica set, typically two.
externalAccessIpAddress String: The publicly routable IP address for the domain controllers in the replica set.
id String: The ID of the Domain Service.
location String: The Azure location in which the replica set resides.
serviceStatus String: The current service status for the replica set.
subnetId String: The ID of the subnet in which the replica set resides.

GetServiceSecureLdap

CertificateExpiry string
CertificateThumbprint string
Enabled bool: Whether secure LDAP is enabled for the managed domain.
ExternalAccessEnabled bool: Whether external access to LDAPS over the Internet, is enabled.
PublicCertificate string

CertificateExpiry string
CertificateThumbprint string
Enabled bool: Whether secure LDAP is enabled for the managed domain.
ExternalAccessEnabled bool: Whether external access to LDAPS over the Internet, is enabled.
PublicCertificate string

certificateExpiry String
certificateThumbprint String
enabled Boolean: Whether secure LDAP is enabled for the managed domain.
externalAccessEnabled Boolean: Whether external access to LDAPS over the Internet, is enabled.
publicCertificate String

certificateExpiry string
certificateThumbprint string
enabled boolean: Whether secure LDAP is enabled for the managed domain.
externalAccessEnabled boolean: Whether external access to LDAPS over the Internet, is enabled.
publicCertificate string

certificate_expiry str
certificate_thumbprint str
enabled bool: Whether secure LDAP is enabled for the managed domain.
external_access_enabled bool: Whether external access to LDAPS over the Internet, is enabled.
public_certificate str

certificateExpiry String
certificateThumbprint String
enabled Boolean: Whether secure LDAP is enabled for the managed domain.
externalAccessEnabled Boolean: Whether external access to LDAPS over the Internet, is enabled.
publicCertificate String

GetServiceSecurity

KerberosArmoringEnabled bool: (Optional) Whether the Kerberos Armoring is enabled.
KerberosRc4EncryptionEnabled bool: (Optional) Whether the Kerberos RC4 Encryption is enabled.
NtlmV1Enabled bool: Whether legacy NTLM v1 support is enabled.
SyncKerberosPasswords bool: Whether Kerberos password hashes are synchronized to the managed domain.
SyncNtlmPasswords bool: Whether NTLM password hashes are synchronized to the managed domain.
SyncOnPremPasswords bool: Whether on-premises password hashes are synchronized to the managed domain.
TlsV1Enabled bool: Whether legacy TLS v1 support is enabled.

KerberosArmoringEnabled bool: (Optional) Whether the Kerberos Armoring is enabled.
KerberosRc4EncryptionEnabled bool: (Optional) Whether the Kerberos RC4 Encryption is enabled.
NtlmV1Enabled bool: Whether legacy NTLM v1 support is enabled.
SyncKerberosPasswords bool: Whether Kerberos password hashes are synchronized to the managed domain.
SyncNtlmPasswords bool: Whether NTLM password hashes are synchronized to the managed domain.
SyncOnPremPasswords bool: Whether on-premises password hashes are synchronized to the managed domain.
TlsV1Enabled bool: Whether legacy TLS v1 support is enabled.

kerberosArmoringEnabled Boolean: (Optional) Whether the Kerberos Armoring is enabled.
kerberosRc4EncryptionEnabled Boolean: (Optional) Whether the Kerberos RC4 Encryption is enabled.
ntlmV1Enabled Boolean: Whether legacy NTLM v1 support is enabled.
syncKerberosPasswords Boolean: Whether Kerberos password hashes are synchronized to the managed domain.
syncNtlmPasswords Boolean: Whether NTLM password hashes are synchronized to the managed domain.
syncOnPremPasswords Boolean: Whether on-premises password hashes are synchronized to the managed domain.
tlsV1Enabled Boolean: Whether legacy TLS v1 support is enabled.

kerberosArmoringEnabled boolean: (Optional) Whether the Kerberos Armoring is enabled.
kerberosRc4EncryptionEnabled boolean: (Optional) Whether the Kerberos RC4 Encryption is enabled.
ntlmV1Enabled boolean: Whether legacy NTLM v1 support is enabled.
syncKerberosPasswords boolean: Whether Kerberos password hashes are synchronized to the managed domain.
syncNtlmPasswords boolean: Whether NTLM password hashes are synchronized to the managed domain.
syncOnPremPasswords boolean: Whether on-premises password hashes are synchronized to the managed domain.
tlsV1Enabled boolean: Whether legacy TLS v1 support is enabled.

kerberos_armoring_enabled bool: (Optional) Whether the Kerberos Armoring is enabled.
kerberos_rc4_encryption_enabled bool: (Optional) Whether the Kerberos RC4 Encryption is enabled.
ntlm_v1_enabled bool: Whether legacy NTLM v1 support is enabled.
sync_kerberos_passwords bool: Whether Kerberos password hashes are synchronized to the managed domain.
sync_ntlm_passwords bool: Whether NTLM password hashes are synchronized to the managed domain.
sync_on_prem_passwords bool: Whether on-premises password hashes are synchronized to the managed domain.
tls_v1_enabled bool: Whether legacy TLS v1 support is enabled.

kerberosArmoringEnabled Boolean: (Optional) Whether the Kerberos Armoring is enabled.
kerberosRc4EncryptionEnabled Boolean: (Optional) Whether the Kerberos RC4 Encryption is enabled.
ntlmV1Enabled Boolean: Whether legacy NTLM v1 support is enabled.
syncKerberosPasswords Boolean: Whether Kerberos password hashes are synchronized to the managed domain.
syncNtlmPasswords Boolean: Whether NTLM password hashes are synchronized to the managed domain.
syncOnPremPasswords Boolean: Whether on-premises password hashes are synchronized to the managed domain.
tlsV1Enabled Boolean: Whether legacy TLS v1 support is enabled.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.