Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.20.0 release - Enrich examples to boost example quality KPI - Batch 5 [domains] #1216

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,27 @@ Get-EntraBetaDomainNameReference

The `Get-EntraBetaDomainNameReference` cmdlet retrieves the objects that are referenced with a given domain name. Specify `Name` parameter retrieve the objects.

The work or school account needs to belong to at least the Domain Name Administrator or Global Reader Microsoft Entra role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator
- Global Reader

## Examples

### Example 1: Retrieve the domain name reference objects for a domain

```powershell
Connect-Entra -Scopes 'Domain.Read.All'
Get-EntraBetaDomainNameReference -Name contoso.com
Get-EntraBetaDomainNameReference -Name contoso.com | Select Id, DisplayName, '@odata.type'
```

```Output
Id DeletedDateTime
-- ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
bbbbbbbb-1111-2222-3333-cccccccccccc
cccccccc-2222-3333-4444-dddddddddddd
dddddddd-3333-4444-5555-eeeeeeeeeeee
ffffffff-4444-5555-6666-gggggggggggg
hhhhhhhh-5555-6666-7777-iiiiiiiiiiii
ID Display Name @odata.type
-- ------------- ------------------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Sawyer MIller #microsoft.graph.user
bbbbbbbb-1111-2222-3333-cccccccccccc Adele Vance #microsoft.graph.user
ffffffff-4444-5555-6666-gggggggggggg Contoso marketing #microsoft.graph.group
hhhhhhhh-5555-6666-7777-iiiiiiiiiiii Contoso App #microsoft.graph.application
```

This example shows how to retrieve the domain name reference objects for a domain that is specified through the -Name parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ Gets the domain's service configuration records from the `serviceConfigurationRe

After you have successfully verified the ownership of a domain and you have indicated what services you plan to use with the domain, you can request Microsoft Entra ID to return you a set of DNS records which you need to add to the zone file of the domain so that the services can work properly with your domain.

In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator
- Global Reader

## Examples

### Example 1: Retrieve domain service configuration records by Name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ To verify the ownership of the domain, you need to first retrieve a set of domai

Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified.

The work or school account needs to belong to at least the Domain Name Administrator or Global Reader Microsoft Entra role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator
- Global Reader

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ window or Password Expiry Notification window for a tenant or specified domain.

When a domain name is specified, it must be a verified domain for the company.

The work or school account needs to belong to one of the following Microsoft Entra roles:
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ New-EntraBetaDomain

The `New-EntraBetaDomain` cmdlet creates a domain in Microsoft Entra ID.

The work or school account needs to belong to at least the Domain Name Administrator role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@ Important:
- Deleted domains are not recoverable.
- Attempts to delete will fail if there are any resources or objects still dependent on the domain.

The work or school account needs to belong to at least the `Domain Name Administrator` Microsoft Entra role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,10 @@ For delegated scenarios, the calling user must be assigned at least one of the f

```powershell
Connect-Entra -Scopes 'Domain.ReadWrite.All'

$params = @{
DomainName = 'contoso.com'
PreferredAuthenticationProtocol = 'WsFed'
PromptLoginBehavior = 'TranslateToFreshPasswordAuth' # Or 'NativeSupport' or 'Disabled', depending on the requirement
}
Set-EntraBetaDomainFederationSettings @params
$domain = 'contoso.com'
$authProtocol = 'WsFed'
$promptLoginBehavior = 'TranslateToFreshPasswordAuth' # Or 'NativeSupport' or 'Disabled', depending on the requirement
Set-EntraBetaDomainFederationSettings -DomainName $domain -PreferredAuthenticationProtocol $authProtocol -PromptLoginBehavior $promptLoginBehavior
```

This command updates the `PromptLoginBehavior` to either `TranslateToFreshPasswordAuth`, `NativeSupport`, or `Disabled`. These possible values are described:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,27 @@ Get-EntraDomainNameReference

The `Get-EntraDomainNameReference` cmdlet retrieves the objects that are referenced with a given domain name. Specify `Name` parameter retrieve the objects.

The work or school account needs to belong to at least the Domain Name Administrator or Global Reader Microsoft Entra role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator
- Global Reader

## Examples

### Example 1: Retrieve the domain name reference objects for a domain

```powershell
Connect-Entra -Scopes 'Domain.Read.All'
Get-EntraDomainNameReference -Name contoso.com
Get-EntraDomainNameReference -Name contoso.com | Select Id, DisplayName, '@odata.type'
```

```Output
Id DeletedDateTime
-- ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
bbbbbbbb-1111-2222-3333-cccccccccccc
cccccccc-2222-3333-4444-dddddddddddd
dddddddd-3333-4444-5555-eeeeeeeeeeee
ffffffff-4444-5555-6666-gggggggggggg
hhhhhhhh-5555-6666-7777-iiiiiiiiiiii
ID Display Name @odata.type
-- ------------- ------------------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Sawyer MIller #microsoft.graph.user
bbbbbbbb-1111-2222-3333-cccccccccccc Adele Vance #microsoft.graph.user
ffffffff-4444-5555-6666-gggggggggggg Contoso marketing #microsoft.graph.group
hhhhhhhh-5555-6666-7777-iiiiiiiiiiii Contoso App #microsoft.graph.application
```

This example shows how to retrieve the domain name reference objects for a domain that is specified through the -Name parameter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ Gets the domain's service configuration records from the `serviceConfigurationRe

After you have successfully verified the ownership of a domain and you have indicated what services you plan to use with the domain, you can request Microsoft Entra ID to return you a set of DNS records which you need to add to the zone file of the domain so that the services can work properly with your domain.

In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator
- Global Reader

## Examples

### Example 1: Retrieve domain service configuration records by Name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ To verify the ownership of the domain, you need to first retrieve a set of domai

Root domains require verification. For example, contoso.com requires verification. If a root domain is verified, subdomains of the root domain are automatically verified. For example, subdomain.contoso.com is automatically be verified if contoso.com has been verified.

The work or school account needs to belong to at least the Domain Name Administrator or Global Reader Microsoft Entra role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator
- Global Reader

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ window or Password Expiry Notification window for a tenant or specified domain.

When a domain name is specified, it must be a verified domain for the company.

The work or school account needs to belong to one of the following Microsoft Entra roles:
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ New-EntraDomain

The `New-EntraDomain` cmdlet creates a domain in Microsoft Entra ID.

The work or school account needs to belong to at least the Domain Name Administrator role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ Important:
- Deleted domains are not recoverable.
- Attempts to delete will fail if there are any resources or objects still dependent on the domain.

The work or school account needs to belong to at least the `Domain Name Administrator` Microsoft Entra role.
In delegated scenarios, the signed-in user must have either a supported Microsoft Entra role or a custom role with the necessary permissions. The minimum roles required for this operation are:

- Domain Name Administrator

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,10 @@ For delegated scenarios, the calling user must be assigned at least one of the f

```powershell
Connect-Entra -Scopes 'Domain.ReadWrite.All'

$params = @{
DomainName = 'contoso.com'
PreferredAuthenticationProtocol = 'WsFed'
PromptLoginBehavior = 'TranslateToFreshPasswordAuth' # Or 'NativeSupport' or 'Disabled', depending on the requirement
}
Set-EntraDomainFederationSettings @params
$domain = 'contoso.com'
$authProtocol = 'WsFed'
$promptLoginBehavior = 'TranslateToFreshPasswordAuth' # Or 'NativeSupport' or 'Disabled', depending on the requirement
Set-EntraDomainFederationSettings -DomainName $domain -PreferredAuthenticationProtocol $authProtocol -PromptLoginBehavior $promptLoginBehavior
```

This command updates the `PromptLoginBehavior` to either `TranslateToFreshPasswordAuth`, `NativeSupport`, or `Disabled`. These possible values are described:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ schema: 2.0.0
# Get-CrossCloudVerificationCode

## Synopsis

Gets the verification code used to validate the ownership of the domain in another connected cloud.
Important: Only applies to a verified domain.

Expand All @@ -36,19 +37,21 @@ Get-CrossCloudVerificationCode
## Examples

### Example 1: Get the cross cloud verification code

```powershell
PS C:\>Get-CrossCloudVerificationCode -Name Contoso.com
Get-CrossCloudVerificationCode -Name Contoso.com
```

This command returns a string that can be used to enable cross cloud federation scenarios.

## Parameters

### -Name

Specifies the name of a domain.

```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -60,13 +63,15 @@ Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## Inputs

## Outputs

### Microsoft.Online.Administration.GetCrossCloudVerificationCodeResponse

## Notes

## RELATED LINKS
## RELATED LINKS