-
Notifications
You must be signed in to change notification settings - Fork 490
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated Resources and Cmdlet documentation pages
- Loading branch information
1 parent
05b1751
commit dea2f7a
Showing
1 changed file
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# ADOOrganizationOwner | ||
|
||
## Parameters | ||
|
||
| Parameter | Attribute | DataType | Description | Allowed Values | | ||
| --- | --- | --- | --- | --- | | ||
| **OrganizationName** | Key | String | NAme of the Azure DevOPS Organization | | | ||
| **Owner** | Write | String | User principal of the organization's owner | | | ||
| **Credential** | Write | PSCredential | Credentials of the workload's Admin | | | ||
| **ApplicationId** | Write | String | Id of the Azure Active Directory application to authenticate with. | | | ||
| **TenantId** | Write | String | Id of the Azure Active Directory tenant used for authentication. | | | ||
| **CertificateThumbprint** | Write | String | Thumbprint of the Azure Active Directory application's authentication certificate to use for authentication. | | | ||
| **ManagedIdentity** | Write | Boolean | Managed ID being used for authentication. | | | ||
| **AccessTokens** | Write | StringArray[] | Access token used for authentication. | | | ||
|
||
|
||
## Description | ||
|
||
Configures the owner of an Azure DevOPS organization. | ||
|
||
## Permissions | ||
|
||
### Microsoft Graph | ||
|
||
To authenticate with the Microsoft Graph API, this resource required the following permissions: | ||
|
||
#### Delegated permissions | ||
|
||
- **Read** | ||
|
||
- None | ||
|
||
- **Update** | ||
|
||
- None | ||
|
||
#### Application permissions | ||
|
||
- **Read** | ||
|
||
- None | ||
|
||
- **Update** | ||
|
||
- None | ||
|
||
## Examples | ||
|
||
### Example 1 | ||
|
||
This example is used to test new resources and showcase the usage of new resources being worked on. | ||
It is not meant to use as a production baseline. | ||
|
||
```powershell | ||
Configuration Example | ||
{ | ||
param( | ||
[Parameter()] | ||
[System.String] | ||
$ApplicationId, | ||
[Parameter()] | ||
[System.String] | ||
$TenantId, | ||
[Parameter()] | ||
[System.String] | ||
$CertificateThumbprint | ||
) | ||
Import-DscResource -ModuleName Microsoft365DSC | ||
node localhost | ||
{ | ||
ADOOrganizationOwner "MyOrgOwner" | ||
{ | ||
ApplicationId = $ApplicationId; | ||
TenantId = $TenantId | ||
CertificateThumbprint = $CertificateThumbprint | ||
OrganizationName = "MyOrg"; | ||
Owner = "john.smith@$TenantId"; | ||
} | ||
} | ||
} | ||
``` | ||
|