Update Directory Config

appstream_update_directory_config

R Documentation

Updates the specified Directory Config object in AppStream 2

Description

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Usage

appstream_update_directory_config(DirectoryName,
  OrganizationalUnitDistinguishedNames, ServiceAccountCredentials,
  CertificateBasedAuthProperties)

Arguments

DirectoryName

[required] The name of the Directory Config object.

OrganizationalUnitDistinguishedNames

The distinguished names of the organizational units for computer accounts.

ServiceAccountCredentials

The credentials for the service account used by the fleet or image builder to connect to the directory.

CertificateBasedAuthProperties

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

Value

A list with the following syntax:

list(
  DirectoryConfig = list(
    DirectoryName = "string",
    OrganizationalUnitDistinguishedNames = list(
      "string"
    ),
    ServiceAccountCredentials = list(
      AccountName = "string",
      AccountPassword = "string"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    CertificateBasedAuthProperties = list(
      Status = "DISABLED"|"ENABLED"|"ENABLED_NO_DIRECTORY_LOGIN_FALLBACK",
      CertificateAuthorityArn = "string"
    )
  )
)

Request syntax

svc$update_directory_config(
  DirectoryName = "string",
  OrganizationalUnitDistinguishedNames = list(
    "string"
  ),
  ServiceAccountCredentials = list(
    AccountName = "string",
    AccountPassword = "string"
  ),
  CertificateBasedAuthProperties = list(
    Status = "DISABLED"|"ENABLED"|"ENABLED_NO_DIRECTORY_LOGIN_FALLBACK",
    CertificateAuthorityArn = "string"
  )
)