ADFS-cmdlet

by Posted on

This blog contains the brief descriptions of the Windows PowerShell cmdlets that are for use in administering the Active Directory Federation Services (ADFS). The Module is adfs-cmdlet

On adfs we have discussed how to configure the module and on this blog we will see which all commands are their in this module.

Add-AdfsAttributeStoreAdds an attribute store to the Federation Service.
Add-AdfsCertificateAdds a new certificate to AD FS for signing, decrypting, or securing communications.
Add-AdfsClaimDescriptionAdds a claim description to the Federation Service.
Add-AdfsClaimsProviderTrustAdds a new claims provider trust to the Federation Service.
Add-AdfsClaimsProviderTrustsGroupCreates a claims provider trust group based on metadata that contains multiple entities.
Add-AdfsClientRegisters an OAuth 2.0 client with AD FS.
Add-AdfsDeviceRegistrationUpnSuffixAdds a custom UPN suffix.
Add-AdfsFarmNodeAdds this computer to an existing federation server farm.
Add-AdfsLocalClaimsProviderTrustCreates a local claims provider trust.
Add-AdfsNativeClientApplicationAdds a native client application role to an application in AD FS.
Add-AdfsNonClaimsAwareRelyingPartyTrustAdds a relying party trust that represents a non-claims-aware web application or service to the Federation Service.
Add-AdfsRelyingPartyTrustAdds a new relying party trust to the Federation Service.
Add-AdfsRelyingPartyTrustsGroupCreates a relying party trusts group.
Add-AdfsScopeDescriptionAdds a scope description in AD FS.
Add-AdfsServerApplicationAdds a server application role to an application in AD FS.
Add-AdfsTrustedFederationPartnerAdds configuration settings for trusted federation partners in AD FS.
Add-AdfsWebApiApplicationAdds a Web API application role to an application in AD FS.
Add-AdfsWebApplicationProxyRelyingPartyTrustAdds a relying party trust for the Web Application Proxy.
Disable-AdfsApplicationGroupDisables an application group.
Disable-AdfsCertificateAuthorityDisables a certificate authority.
Disable-AdfsClaimsProviderTrustDisables a claims provider trust in the Federation Service.
Disable-AdfsNonClaimsAwareRelyingPartyTrustDisables a relying party trust for a non-claims-aware web application or service from the Federation Service.
Disable-AdfsClientDisables an OAuth 2.0 client that is currently registered with AD FS.
Disable-AdfsDeviceRegistrationMarks the Device Registration Service as disabled on an AD FS server.
Disable-AdfsEndpointDisables an endpoint of AD FS.
Disable-AdfsNonClaimsAwareRelyingPartyTrustDisables a relying party trust for a non-claims-aware web application or service from the Federation Service.
Disable-AdfsRelyingPartyTrustDisables a relying party trust of the Federation Service.
Disable-AdfsWebApplicationProxyRelyingPartyTrustDisables the relying party trust for the Web Application Proxy.
Enable-AdfsApplicationGroupEnables an application group in AD FS.
Enable-AdfsClaimsProviderTrustEnables a claims provider trust in the Federation Service.
Enable-AdfsClientEnables the use of an OAuth 2.0 client registration by AD FS.
Enable-AdfsDeviceRegistrationConfigures a server in an AD FS farm to host the Device Registration Service.
Enable-AdfsEndpointEnables an endpoint in AD FS.
Enable-AdfsLocalClaimsProviderTrustEnables a local claims provider trust.
Enable-AdfsNonClaimsAwareRelyingPartyTrustEnables a relying party trust for a non-claims-aware web application or service from the Federation Service.
Enable-AdfsRelyingPartyTrustEnables a relying party trust of the Federation Service.
Enable-AdfsWebApplicationProxyRelyingPartyTrustEnables the relying party trust object for the Web Application Proxy.
Export-AdfsAuthenticationProviderConfigurationDataExports the custom configuration of an external authentication provider to a file.
Export-AdfsDeploymentSQLScriptGenerates SQL scripts to create the AD FS database and to grant permissions.
Export-AdfsWebContentExports properties of all web content objects in a specific locale to a specified file.
Export-AdfsWebThemeExports a web theme to a folder.
Get-AdfsAccessControlPolicyGets an AD FS access control policy.
Get-AdfsAdditionalAuthenticationRuleRetrieves the global rules that trigger additional authentication providers to be invoked.
Get-AdfsApplicationGroupGets an application group.
Get-AdfsApplicationPermissionGets permission for an application.
Get-AdfsAttributeStoreGets the attribute stores of the Federation Service.
Get-AdfsAuthenticationProviderGets a list of all authentication providers in AD FS.
Get-AdfsAuthenticationProviderWebContentRetrieves web content objects for authentication providers.
Get-AdfsAzureMfaConfiguredGets whether Azure MFA is enabled.
Get-AdfsCertificateRetrieves the certificates from AD FS.
Get-AdfsCertificateAuthorityGets a certificate authority.
Get-AdfsClaimDescriptionGets claim descriptions from the Federation Service.
Get-AdfsClaimsProviderTrustGets the claims provider trusts in the Federation Service.
Get-AdfsClaimsProviderTrustsGroupGets an AD FS claims provider trust group.
Get-AdfsClientRetrieves registration information for an OAuth 2.0 client.
Get-AdfsDeviceRegistrationGets the administrative polices of the Device Registration Service.
Get-AdfsDeviceRegistrationUpnSuffixGets the UPN suffixes that can be used with device registration.
Get-AdfsEndpointRetrieves an endpoint in AD FS.
Get-AdfsFarmInformationGets AD FS behavior level and farm node information.
Get-AdfsGlobalAuthenticationPolicyDisplays the AD FS global policy.
Get-AdfsGlobalWebContentGets global web content objects.
Get-AdfsLocalClaimsProviderTrustGets local claims provider trusts.
Get-AdfsNativeClientApplicationGets native client application roles from an application in AD FS.
Get-AdfsNonClaimsAwareRelyingPartyTrustGets the properties of a relying party trust for a non-claims-aware web application or service.
Get-AdfsPropertiesGets all the associated properties for the AD FS service.
Get-AdfsRegistrationHostsThe Get-AdfsRegistrationHosts cmdlet is deprecated.
Get-AdfsRelyingPartyTrustGets the relying party trusts of the Federation Service.
Get-AdfsRelyingPartyTrustsGroupGets a relying party trust group.
Get-AdfsRelyingPartyWebContentGets web content objects for relying parties.
Get-AdfsRelyingPartyWebThemeGets properties of web themes applied to relying party trusts.
Get-AdfsScopeDescriptionGets a description for a scope in AD FS.
Get-AdfsServerApplicationGets configuration settings for a server application role for an application in AD FS.
Get-AdfsSslCertificateGets the host name, port, and certificate hash for SSL bindings configured for AD FS and the device registration service.
Get-AdfsSyncPropertiesGets synchronization properties the configuration database of AD FS.
Get-AdfsTrustedFederationPartnerGets a trusted federation partner in AD FS.
Get-AdfsWebApiApplicationGets Web API application roles in AD FS.
Get-AdfsWebApplicationProxyRelyingPartyTrustGets the relying party trust object for the Web Application Proxy.
Get-AdfsWebConfigGets AD FS web customization configuration settings.
Get-AdfsWebThemeGets web themes.
Grant-AdfsApplicationPermissionGrants application permission.
Import-AdfsAuthenticationProviderConfigurationDataImports the custom configuration for an authentication provider.
Import-AdfsWebContentImports properties from a resource file into global and relying party web content objects.
Initialize-ADDeviceRegistrationInitializes the Device Registration Service configuration in the Active Directory forest.
Install-AdfsFarmCreates the first node of a new federation server farm.
Invoke-AdfsFarmBehaviorLevelRaiseRaises the behavior level of a farm.
New-AdfsAccessControlPolicyCreates an AD FS access control policy.
New-AdfsApplicationGroupCreates an application group.
New-AdfsAzureMfaTenantCertificateCreates a certificate for the AD FS farm to use to connect to Azure MFA, or returns the currently configured certificate.
New-AdfsClaimRuleSetCreates a set of claim rules.
New-AdfsContactPersonCreates a contact person object.
New-AdfsLdapAttributeToClaimMappingCreates a mapping between an attribute of an LDAP folder and an AD FS claim type.
New-AdfsLdapServerConnectionCreates a connection object.
New-AdfsOrganizationCreates a new organization information object.
New-AdfsSamlEndpointCreates a SAML protocol endpoint object.
New-AdfsWebThemeCreates an AD FS web theme.
Publish-SslCertificateThe Publish-SslCertificate cmdlet is deprecated.
Register-AdfsAuthenticationProviderRegisters an external authentication provider in AD FS.
Remove-AdfsAccessControlPolicyRemoves an AD FS access control policy.
Remove-AdfsApplicationGroupRemoves an application group.
Remove-AdfsAttributeStoreRemoves an attribute store from the Federation Service.
Remove-AdfsAuthenticationProviderWebContentRemoves web content customization of the authentication provider in the user sign-in web pages from AD FS.
Remove-AdfsCertificateRemoves a certificate from AD FS.
Remove-AdfsClaimDescriptionRemoves a claim description from the Federation Service.
Remove-AdfsClaimsProviderTrustRemoves a claims provider trust from the Federation Service.
Remove-AdfsClaimsProviderTrustsGroupRemoves an AD FS claims provider trust group.
Remove-AdfsClientDeletes registration information for an OAuth 2.0 client that is currently registered with AD FS.
Remove-AdfsDeviceRegistrationUpnSuffixRemoves a custom UPN suffix.
Remove-AdfsFarmNodeThe Remove-AdfsFarmNode cmdlet is deprecated.
Remove-AdfsGlobalWebContentRemoves a global web content object.
Remove-AdfsLocalClaimsProviderTrustRemoves a local claims provider trust.
Remove-AdfsNativeClientApplicationRemoves a native client application role from an application in AD FS.
Remove-AdfsNonClaimsAwareRelyingPartyTrustRemoves a relying party trust for a non-claims-aware web application or service from the Federation Service.
Remove-AdfsRelyingPartyTrustRemoves a relying party trust from the Federation Service.
Remove-AdfsRelyingPartyTrustsGroupRemoves a relying party trusts group.
Remove-AdfsRelyingPartyWebContentRemoves a relying party web content object.
Remove-AdfsRelyingPartyWebThemeRemoves a web theme to a relying party.
Remove-AdfsScopeDescriptionRemoves a scope description in AD FS.
Remove-AdfsServerApplicationRemoves a server application role from an application in AD FS.
Remove-AdfsTrustedFederationPartnerRemoves a trusted federation partner in AD FS.
Remove-AdfsWebApiApplicationRemoves a Web API application role from an application in AD FS.
Remove-AdfsWebApplicationProxyRelyingPartyTrustRemoves the relying party trust object for the Web Application Proxy.
Remove-AdfsWebThemeRemoves a web theme.
Restore-AdfsFarmBehaviorLevelRestores the farm to a previous behavior level.
Revoke-AdfsApplicationPermissionRevokes permission for an application.
Revoke-AdfsProxyTrustRevokes trust for all adfs2_fsp configured for the Federation Service.
Set-AdfsAccessControlPolicyModifies an AD FS access control policy.
Set-AdfsAlternateTlsClientBindingConfigures an existing AD FS deployment to use the same port for both device certificate and client certificate authentication.
Set-AdfsAdditionalAuthenticationRuleSets the global rules that provide the trigger for additional authentication providers to be invoked.
Set-AdfsApplicationGroupModifies an application group.
Set-AdfsApplicationPermissionModifies application permissions.
Set-AdfsAttributeStoreModifies properties of an attribute store.
Set-AdfsAuthenticationProviderWebContentModifies a display name and description.
Set-AdfsCertSharingContainerSets the account that is used for sharing managed certificates in a federation server farm.
Set-AdfsAzureMfaTenantEnables an AD FS farm to use MFA.
Set-AdfsCertificateSets the properties of an existing certificate that AD FS uses to sign, decrypt, or secure communications.
Set-AdfsClaimDescriptionModifies the properties of a claim description.
Set-AdfsClaimsProviderTrustSets the properties of a claims provider trust.
Set-AdfsClientModifies registration settings for an OAuth 2.0 client registered with AD FS.
Set-AdfsDeviceRegistrationConfigures the administrative policies for the Device Registration Service.
Set-AdfsDeviceRegistrationUpnSuffixSets the list of UPN suffixes.
Set-AdfsEndpointSets the endpoint on a Web Application Proxy.
Set-AdfsFarmInformationRemoves a stale or offline farm node from the farm information table.
Set-AdfsGlobalAuthenticationPolicyModifies the AD FS global policy.
Set-AdfsGlobalWebContentSets properties for global web content objects.
Set-AdfsLocalClaimsProviderTrustModifies a local claims provider trust.
Set-AdfsNativeClientApplicationModifies configuration settings for a server native client application role of an application in AD FS.
Set-AdfsNonClaimsAwareRelyingPartyTrustSets the properties of a relying party trust for a non-claims-aware web application or service.
Set-AdfsPropertiesSets the properties that control global behaviors in AD FS.
Set-AdfsRegistrationHostsThe Set-AdfsRegistrationHosts cmdlet is deprecated.
Set-AdfsRelyingPartyTrustSets the properties of a relying party trust.
Set-AdfsRelyingPartyWebContentSets properties for the relying party web content objects.
Set-AdfsRelyingPartyWebThemeApplies a web theme to a relying party.
Set-AdfsScopeDescriptionModifies a scope description in AD FS.
Set-AdfsServerApplicationModifies configuration settings for a server application role of an application in AD FS.
Set-AdfsSslCertificateSets an SSL certificate for HTTPS bindings for AD FS and the device registration service.
Set-AdfsSyncPropertiesModifies the frequency of synchronization for the AD FS configuration database and which server is primary in the farm.
Set-AdfsTrustedFederationPartnerModifies configuration settings for trusted federation partners in AD FS.
Set-AdfsWebApiApplicationModifies configuration settings for a Web API application in AD FS.
Set-AdfsWebApplicationProxyRelyingPartyTrustModifies properties of the relying party trust object for the Web Application Proxy.
Set-AdfsWebConfigModifies web customization configuration settings.
Set-AdfsWebThemeModifies properties of a web theme.
Test-AdfsFarmBehaviorLevelRaiseTests whether you can raise the behavior level of a farm.
Test-AdfsFarmBehaviorLevelRestoreTests whether you can restore an AD FS farm to a previous behavior level.
Test-AdfsFarmInstallationRuns prerequisite checks for installing a new federation server farm.
Test-AdfsFarmJoinRuns prerequisite checks for adding the server computer to a federation server farm.
Unregister-AdfsAuthenticationProviderDeletes an external authentication provider from AD FS.
Update-AdfsCertificateUpdates the certificates of AD FS.
Update-AdfsClaimsProviderTrustUpdates the claims provider trust from federation metadata.
Update-AdfsRelyingPartyTrustUpdates the relying party trust from federation metadata.

Click on this Link, for an Single place where you get all the PowerShell cmdlet sorted based on the modules.

You can also refer other blogs on PowerShell at link

You can also refer other blogs on Microsoft at link

And also if you required any technology you want to learn, let us know below we will publish them in our site http://tossolution.com/

Like our page in Facebook and follow us for New technical information. Paragraph

References are taken from official Microsoft websites

Published by Karthik S

Lead DevOps | Windows | AWS | Azure | Docker | Kubernetes | Jenkins

Leave a Reply

Your email address will not be published. Required fields are marked *