From 0f1eeedd772a260ac93d75b7a98991dd30ae5d61 Mon Sep 17 00:00:00 2001 From: Eunice Waweru <73849846+msewaweru@users.noreply.github.com> Date: Fri, 5 Aug 2022 20:02:40 +0300 Subject: [PATCH] Added examples to the cmdlets --- .../Get-MgDomainFederationConfiguration.md | 31 +++++++++++-------- .../New-MgDomainFederationConfiguration.md | 31 +++++++++++-------- .../Remove-MgDomainFederationConfiguration.md | 17 ++-------- .../Update-MgDomainFederationConfiguration.md | 17 ++-------- 4 files changed, 42 insertions(+), 54 deletions(-) diff --git a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Get-MgDomainFederationConfiguration.md b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Get-MgDomainFederationConfiguration.md index 093355d11d5..e04603aed68 100644 --- a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Get-MgDomainFederationConfiguration.md +++ b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Get-MgDomainFederationConfiguration.md @@ -1,18 +1,23 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Get the federation settings for a federated domain -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +Get-MgDomainFederationConfiguration -DomainId 'contoso.com' -InternalDomainFederationId '2a8ce608-bb34-473f-9e0f-f373ee4cbc5a' | Format-List -{{ Add output here }} +ActiveSignInUri : https://sts.deverett.info/adfs/services/trust/2005/usernamemixed +DisplayName : Contoso +FederatedIdpMfaBehavior : rejectMfaByFederatedIdp +Id : 2a8ce608-bb34-473f-9e0f-f373ee4cbc5a +IsSignedAuthenticationRequestRequired : +IssuerUri : http://contoso.com/adfs/services/trust/ +MetadataExchangeUri : https://sts.contoso.com/adfs/services/trust/mex +NextSigningCertificate : MIIC3jCCAcagAwIBAgIQEt0T0G5GPZ9 +PassiveSignInUri : https://sts.contoso.com/adfs/ls/ +PreferredAuthenticationProtocol : wsFed +PromptLoginBehavior : +SignOutUri : https://sts.deverett.info/adfs/ls/ +SigningCertificate : MIIC3jCCAcagAwIBAgIQFsO0R8deG4h +SigningCertificateUpdateStatus : Microsoft.Graph.PowerShell.Models.MicrosoftGraphSigningCertificateUpdateStatus +AdditionalProperties : {[@odata.context, https://graph.microsoft.com/v1.0/$metadata#domains('contoso.com')/federationConfiguration/$entity]} ``` -{{ Add description here }} - +This examples retrieves the federation settings for the specified domain. diff --git a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/New-MgDomainFederationConfiguration.md b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/New-MgDomainFederationConfiguration.md index 093355d11d5..747ffcf18ff 100644 --- a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/New-MgDomainFederationConfiguration.md +++ b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/New-MgDomainFederationConfiguration.md @@ -1,18 +1,23 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Configure federation settings for a federated domain -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} +New-MgDomainFederationConfiguration -DomainId "contoso.com" -ActiveSignInUri "https://sts.contoso.com/adfs/services/trust/2005/usernamemixed" -DisplayName "Contoso" -IssuerUri "http://contoso.com/adfs/services/trust/" -MetadataExchangeUri "https://sts.contoso.com/adfs/services/trust/mex" -NextSigningCertificate "MIIC3jCCAcagAwIBAgIQEt0T0G5GPZ9" -PassiveSignInUri "https://sts.contoso.com/adfs/ls/" -SignOutUri "https://sts.contoso.com/adfs/ls/" -SigningCertificate "MIIC3jCCAcagAwIBAgIQFsO0R8deG4h" -FederatedIdpMfaBehavior "rejectMfaByFederatedIdp" | Format-List -{{ Add output here }} +ActiveSignInUri : https://sts.deverett.info/adfs/services/trust/2005/usernamemixed +DisplayName : Contoso +FederatedIdpMfaBehavior : rejectMfaByFederatedIdp +Id : 2a8ce608-bb34-473f-9e0f-f373ee4cbc5a +IsSignedAuthenticationRequestRequired : +IssuerUri : http://contoso.com/adfs/services/trust/ +MetadataExchangeUri : https://sts.contoso.com/adfs/services/trust/mex +NextSigningCertificate : MIIC3jCCAcagAwIBAgIQEt0T0G5GPZ9 +PassiveSignInUri : https://sts.contoso.com/adfs/ls/ +PreferredAuthenticationProtocol : wsFed +PromptLoginBehavior : +SignOutUri : https://sts.deverett.info/adfs/ls/ +SigningCertificate : MIIC3jCCAcagAwIBAgIQFsO0R8deG4h +SigningCertificateUpdateStatus : Microsoft.Graph.PowerShell.Models.MicrosoftGraphSigningCertificateUpdateStatus +AdditionalProperties : {[@odata.context, https://graph.microsoft.com/v1.0/$metadata#domains('contoso.com')/federationConfiguration/$entity]} ``` -{{ Add description here }} - +This examples creates new federation settings for the specified domain. diff --git a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Remove-MgDomainFederationConfiguration.md b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Remove-MgDomainFederationConfiguration.md index 093355d11d5..d3f4993554f 100644 --- a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Remove-MgDomainFederationConfiguration.md +++ b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Remove-MgDomainFederationConfiguration.md @@ -1,18 +1,7 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Remove federation settigs for a federated domain -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} +Remove-MgDomainFederationConfiguration -DomainId 'contoso.com' -InternalDomainFederationId '2a8ce608-bb34-473f-9e0f-f373ee4cbc5a' ``` -{{ Add description here }} - +This example removes the federation settings of the specified federated domain. diff --git a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Update-MgDomainFederationConfiguration.md b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Update-MgDomainFederationConfiguration.md index 093355d11d5..dcd3a11bb7a 100644 --- a/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Update-MgDomainFederationConfiguration.md +++ b/src/Identity.DirectoryManagement/Identity.DirectoryManagement/examples/v1.0/Update-MgDomainFederationConfiguration.md @@ -1,18 +1,7 @@ -### Example 1: {{ Add title here }} -```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} -``` +### Example 1: Update the federation settings for a federated domain -{{ Add description here }} - -### Example 2: {{ Add title here }} ```powershell -PS C:\> {{ Add code here }} - -{{ Add output here }} +Update-MgDomainFederationConfiguration -DomainId 'contoso.com' -InternalDomainFederationId '2a8ce608-bb34-473f-9e0f-f373ee4cbc5a' -DisplayName "Contoso name change" ``` -{{ Add description here }} - +This example updates the DisplayName setting.