Skip to content

Commit 4e4cc6b

Browse files
authored
Added verified domain info when creating service principal (MicrosoftDocs#1934)
1 parent ef28a0c commit 4e4cc6b

File tree

6 files changed

+125
-2
lines changed

6 files changed

+125
-2
lines changed

azps-5.9.0/Az.Resources/New-AzADApplication.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ original_content_git_url: https://github.com/Azure/azure-powershell/blob/master/
1313
## SYNOPSIS
1414
Creates a new azure active directory application.
1515

16+
> [!IMPORTANT]
17+
> The value of the 'IdentifierUri' parameter for `New-AzAdApplication` must use a verified domain of
18+
> the organization or its subdomain. For more information, see
19+
> [Troubleshooting the Azure Az PowerShell module](/powershell/azure/troubleshooting#service-principal-identifieruri-verified-domain-error).
20+
1621
## SYNTAX
1722

1823
### ApplicationWithoutCredentialParameterSet (Default)
@@ -144,7 +149,7 @@ Accept wildcard characters: False
144149
145150
### -EndDate
146151
The effective end date of the credential usage.
147-
The default end date value is one year from today.
152+
The default end date value is one year from today.
148153
For an "asymmetric" type credential, this must be set to on or before the date that the X509 certificate is valid.
149154
150155
```yaml
@@ -251,7 +256,7 @@ Accept wildcard characters: False
251256
252257
### -StartDate
253258
The effective start date of the credential usage.
254-
The default start date value is today.
259+
The default start date value is today.
255260
For an "asymmetric" type credential, this must be set to on or after the date that the X509 certificate is valid from.
256261
257262
```yaml

azps-5.9.0/Az.Resources/New-AzADServicePrincipal.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ original_content_git_url: https://github.com/Azure/azure-powershell/blob/master/
1313
## SYNOPSIS
1414
Creates a new Azure active directory service principal.
1515

16+
> [!IMPORTANT]
17+
> The value of the 'IdentifierUri' parameter for `New-AzAdApplication` must use a verified domain of
18+
> the organization or its subdomain. For more information, see
19+
> [Troubleshooting the Azure Az PowerShell module](/powershell/azure/troubleshooting#service-principal-identifieruri-verified-domain-error).
20+
1621
## SYNTAX
1722

1823
### SimpleParameterSet (Default)

docs-conceptual/azps-5.9.0/create-azure-service-principal-azureps.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ ms.custom: devx-track-azurepowershell
1212
Automated tools that use Azure services should always have restricted permissions. Instead of having
1313
applications sign in as a fully privileged user, Azure offers service principals.
1414

15+
> [!IMPORTANT]
16+
> The value of the 'IdentifierUri' parameter for `New-AzAdApplication` must use a verified domain of
17+
> the organization or its subdomain. For more information, see
18+
> [Troubleshooting the Azure Az PowerShell module](/powershell/azure/troubleshooting#service-principal-identifieruri-verified-domain-error).
19+
1520
An Azure service principal is an identity created for use with applications, hosted services, and
1621
automated tools to access Azure resources. This access is restricted by the roles assigned to the
1722
service principal, giving you control over which resources can be accessed and at which level. For

docs-conceptual/azps-5.9.0/troubleshooting.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,39 @@ each time you start a new PowerShell session.
6666
```powershell
6767
Disable-AzContextAutosave
6868
```
69+
70+
## Service Principal IdentifierUri verified domain error
71+
72+
Error: _Values of identifierUris property must use a verified domain of the organization or its
73+
subdomain_ is displayed when running `New-AzADServicePrincipal` or `New-AzADApplication`.
74+
75+
Due to the Azure Active Directory breaking change requiring [AppId Uri in single tenant applications
76+
to require use of default scheme or verified
77+
domains](/active-directory/develop/reference-breaking-changes#appid-uri-in-single-tenant-applications-will-require-use-of-default-scheme-or-verified-domains)
78+
you must upgrade the [Az.Resources](https://www.powershellgallery.com/packages/Az.Resources) module
79+
to version 4.1.0 or later to continue using `New-AzADServicePrincipal` or `New-AzADApplication` cmdlets.
80+
81+
You can also upgrade to Az PowerShell module version 6.0 or greater.
82+
83+
### Timeline
84+
85+
The requirement will be in effect starting 10/15/2021.
86+
87+
### Impacted versions
88+
89+
The following versions of Azure PowerShell are impacted by the AzureAD breaking change:
90+
91+
- Az.Resources PowerShell module version 3.5.1-preview or lesser.
92+
- Az PowerShell module version 5.9.0 or lesser.
93+
94+
If you are still encountering issues after upgrading, feel free to open an
95+
[issue](https://github.com/Azure/azure-powershell/issues/new?assignees=&labels=needs-triage&template=az-module-bug-report.md&title=).
96+
97+
### Workaround
98+
99+
If you cannot upgrade to the PowerShell modules described above, you may follow those steps when
100+
creating a service principal:
101+
102+
- If needed, [add your custom domain name using Azure Active Directory portal](/active-directory/fundamentals/add-custom-domain)
103+
- Create an application with an accepted IdentifierUri
104+
- Create a service principal referring this application

docs-conceptual/azps-6.4.0/troubleshooting.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,39 @@ each time you start a new PowerShell session.
6666
```powershell
6767
Disable-AzContextAutosave
6868
```
69+
70+
## Service Principal IdentifierUri verified domain error
71+
72+
Error: _Values of identifierUris property must use a verified domain of the organization or its
73+
subdomain_ is displayed when running `New-AzADServicePrincipal` or `New-AzADApplication`.
74+
75+
Due to the Azure Active Directory breaking change requiring [AppId Uri in single tenant applications
76+
to require use of default scheme or verified
77+
domains](/active-directory/develop/reference-breaking-changes#appid-uri-in-single-tenant-applications-will-require-use-of-default-scheme-or-verified-domains)
78+
you must upgrade the [Az.Resources](https://www.powershellgallery.com/packages/Az.Resources) module
79+
to version 4.1.0 or later to continue using `New-AzADServicePrincipal` or `New-AzADApplication` cmdlets.
80+
81+
You can also upgrade to Az PowerShell module version 6.0 or greater.
82+
83+
### Timeline
84+
85+
The requirement will be in effect starting 10/15/2021.
86+
87+
### Impacted versions
88+
89+
The following versions of Azure PowerShell are impacted by the AzureAD breaking change:
90+
91+
- Az.Resources PowerShell module version 3.5.1-preview or lesser.
92+
- Az PowerShell module version 5.9.0 or lesser.
93+
94+
If you are still encountering issues after upgrading, feel free to open an
95+
[issue](https://github.com/Azure/azure-powershell/issues/new?assignees=&labels=needs-triage&template=az-module-bug-report.md&title=).
96+
97+
### Workaround
98+
99+
If you cannot upgrade to the PowerShell modules described above, you may follow those steps when
100+
creating a service principal:
101+
102+
- If needed, [add your custom domain name using Azure Active Directory portal](/active-directory/fundamentals/add-custom-domain)
103+
- Create an application with an accepted IdentifierUri
104+
- Create a service principal referring this application

docs-conceptual/azps-6.5.0/troubleshooting.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,39 @@ each time you start a new PowerShell session.
6666
```powershell
6767
Disable-AzContextAutosave
6868
```
69+
70+
## Service Principal IdentifierUri verified domain error
71+
72+
Error: _Values of identifierUris property must use a verified domain of the organization or its
73+
subdomain_ is displayed when running `New-AzADServicePrincipal` or `New-AzADApplication`.
74+
75+
Due to the Azure Active Directory breaking change requiring [AppId Uri in single tenant applications
76+
to require use of default scheme or verified
77+
domains](/active-directory/develop/reference-breaking-changes#appid-uri-in-single-tenant-applications-will-require-use-of-default-scheme-or-verified-domains)
78+
you must upgrade the [Az.Resources](https://www.powershellgallery.com/packages/Az.Resources) module
79+
to version 4.1.0 or later to continue using `New-AzADServicePrincipal` or `New-AzADApplication` cmdlets.
80+
81+
You can also upgrade to Az PowerShell module version 6.0 or greater.
82+
83+
### Timeline
84+
85+
The requirement will be in effect starting 10/15/2021.
86+
87+
### Impacted versions
88+
89+
The following versions of Azure PowerShell are impacted by the AzureAD breaking change:
90+
91+
- Az.Resources PowerShell module version 3.5.1-preview or lesser.
92+
- Az PowerShell module version 5.9.0 or lesser.
93+
94+
If you are still encountering issues after upgrading, feel free to open an
95+
[issue](https://github.com/Azure/azure-powershell/issues/new?assignees=&labels=needs-triage&template=az-module-bug-report.md&title=).
96+
97+
### Workaround
98+
99+
If you cannot upgrade to the PowerShell modules described above, you may follow those steps when
100+
creating a service principal:
101+
102+
- If needed, [add your custom domain name using Azure Active Directory portal](/active-directory/fundamentals/add-custom-domain)
103+
- Create an application with an accepted IdentifierUri
104+
- Create a service principal referring this application

0 commit comments

Comments
 (0)