-
Notifications
You must be signed in to change notification settings - Fork 0
Resources
This page provides a complete reference for all DSC resources available in AzureDevOpsDscNative.
Manage organization-level groups, memberships, and settings.
Create and manage projects, project groups, and project-level resources.
Manage teams and team members.
Manage Git repositories, permissions, and repository settings.
Manage permissions for various Azure DevOps resources and security settings.
Configure pipelines, environments, and pipeline-related resources.
Manage service connections and variable groups.
Configure agent pools, queues, and deployment groups.
Manage artifact feeds and feed settings.
Configure branch policies and other governance settings.
Miscellaneous resources for extensions, wikis, task groups, and more.
Manages Azure DevOps organization-level groups.
Key Properties:
-
GroupName(Key, Required) - Name of the group -
Ensure(Optional) - Ensure presence or absence -
GroupDescription(Optional) - Description of the group
Manages membership within Azure DevOps groups.
Key Properties:
-
GroupName(Key, Required) - Name of the group -
MemberDescriptor(Key, Required) - Descriptor of the member to add/remove -
Ensure(Optional) - Ensure presence or absence
Manages permissions for Azure DevOps groups.
Key Properties:
-
GroupName(Key, Required) - Name of the group -
PermissionName(Key, Required) - Name of the permission -
Allow(Optional) - Grant or deny permission -
Deny(Optional) - Explicitly deny permission
Configures organization-level settings.
Key Properties:
-
OrganizationName(Key, Required) - Name of the organization - Various settings properties
Manages user entitlements in Azure DevOps.
Key Properties:
-
UserEmail(Key, Required) - Email address of the user -
AccessLevel(Optional) - Access level for the user -
Ensure(Optional) - Ensure presence or absence
Creates and manages Azure DevOps projects.
Key Properties:
-
ProjectName(Key, Required) - Name of the project -
ProjectDescription(Optional) - Description of the project -
SourceControlType(Optional) - 'Git' or 'Tfvc' (default: 'Git') -
ProcessTemplate(Optional) - Process template ('Agile', 'Scrum', 'CMMI', 'Basic') -
Visibility(Optional) - 'Public' or 'Private' (default: 'Private') -
Ensure(Optional) - Ensure presence or absence
Manages groups at the project level.
Key Properties:
-
ProjectName(Key, Required) - Name of the project -
GroupName(Key, Required) - Name of the group -
GroupDescription(Optional) - Description of the group -
Ensure(Optional) - Ensure presence or absence
Manages which services are enabled for a project.
Key Properties:
-
ProjectName(Key, Required) - Name of the project - Various service properties (Pipelines, Repos, Boards, etc.)
Manages project-level permissions.
Key Properties:
-
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission -
Allow/Deny(Optional) - Permission setting
Configures project-level settings.
Key Properties:
-
ProjectName(Key, Required) - Name of the project - Various settings properties
Creates and manages teams within a project.
Key Properties:
-
TeamName(Key, Required) - Name of the team -
ProjectName(Key, Required) - Name of the project -
TeamDescription(Optional) - Description of the team -
Ensure(Optional) - Ensure presence or absence
Manages team membership.
Key Properties:
-
TeamName(Key, Required) - Name of the team -
ProjectName(Key, Required) - Name of the project -
MemberName(Key, Required) - Name/email of the member -
Ensure(Optional) - Ensure presence or absence
Configures team-specific settings.
Key Properties:
-
TeamName(Key, Required) - Name of the team -
ProjectName(Key, Required) - Name of the project - Various settings properties
Creates and manages Git repositories.
Key Properties:
-
RepositoryName(Key, Required) - Name of the repository -
ProjectName(Key, Required) - Name of the project -
Ensure(Optional) - Ensure presence or absence -
DefaultBranch(Optional) - Default branch name
Manages Git repository permissions.
Key Properties:
-
RepositoryName(Key, Required) - Name of the repository -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Configures repository-level settings.
Key Properties:
-
RepositoryName(Key, Required) - Name of the repository -
ProjectName(Key, Required) - Name of the project - Various settings properties
Manages area nodes (work item classification).
Key Properties:
-
AreaPath(Key, Required) - Path to the area node -
ProjectName(Key, Required) - Name of the project -
Ensure(Optional) - Ensure presence or absence
Manages iteration/sprint nodes.
Key Properties:
-
IterationPath(Key, Required) - Path to the iteration node -
ProjectName(Key, Required) - Name of the project -
StartDate(Optional) - Start date of the iteration -
EndDate(Optional) - End date of the iteration
Manages permissions for area nodes.
Key Properties:
-
AreaPath(Key, Required) - Path to the area -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Manages permissions for iteration nodes.
Key Properties:
-
IterationPath(Key, Required) - Path to the iteration -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Manages permissions at the security namespace level.
Key Properties:
-
SecurityNamespaceName(Key, Required) - Name of the security namespace -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Configures branch protection policies.
Key Properties:
-
RepositoryName(Key, Required) - Name of the repository -
ProjectName(Key, Required) - Name of the project -
BranchName(Key, Required) - Branch to protect - Various policy properties
Creates and manages pipelines.
Key Properties:
-
PipelineName(Key, Required) - Name of the pipeline -
ProjectName(Key, Required) - Name of the project -
YamlPath(Optional) - Path to pipeline YAML file -
Ensure(Optional) - Ensure presence or absence
Manages pipeline permissions.
Key Properties:
-
PipelineName(Key, Required) - Name of the pipeline -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Manages deployment environments for pipelines.
Key Properties:
-
EnvironmentName(Key, Required) - Name of the environment -
ProjectName(Key, Required) - Name of the project -
Ensure(Optional) - Ensure presence or absence
Manages environment permissions.
Key Properties:
-
EnvironmentName(Key, Required) - Name of the environment -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Configures environment approvals.
Key Properties:
-
EnvironmentName(Key, Required) - Name of the environment -
ProjectName(Key, Required) - Name of the project -
ApproverName(Key, Required) - Name of the approver -
Ensure(Optional) - Ensure presence or absence
Configures pipeline-level settings.
Key Properties:
-
ProjectName(Key, Required) - Name of the project - Various pipeline settings properties
Manages pipeline check configurations.
Key Properties:
-
CheckName(Key, Required) - Name of the check -
ProjectName(Key, Required) - Name of the project - Various check configuration properties
Creates and manages service connections.
Key Properties:
-
ServiceConnectionName(Key, Required) - Name of the service connection -
ProjectName(Key, Required) - Name of the project -
ServiceConnectionType(Required) - Type of connection - Various connection-specific properties
-
Ensure(Optional) - Ensure presence or absence
Manages service connection permissions.
Key Properties:
-
ServiceConnectionName(Key, Required) - Name of the connection -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Creates and manages variable groups.
Key Properties:
-
VariableGroupName(Key, Required) - Name of the variable group -
ProjectName(Key, Required) - Name of the project -
Variables(Optional) - Hashtable of variables -
Ensure(Optional) - Ensure presence or absence
Manages variable group permissions.
Key Properties:
-
VariableGroupName(Key, Required) - Name of the variable group -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Creates and manages agent pools.
Key Properties:
-
PoolName(Key, Required) - Name of the agent pool -
PoolDescription(Optional) - Description of the pool -
Ensure(Optional) - Ensure presence or absence
Manages agent pool permissions.
Key Properties:
-
PoolName(Key, Required) - Name of the agent pool -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Manages agent queues (project-level queue mappings).
Key Properties:
-
QueueName(Key, Required) - Name of the queue -
ProjectName(Key, Required) - Name of the project -
PoolName(Required) - Associated agent pool name
Creates and manages deployment groups.
Key Properties:
-
DeploymentGroupName(Key, Required) - Name of the deployment group -
ProjectName(Key, Required) - Name of the project -
Ensure(Optional) - Ensure presence or absence
Creates and manages artifact feeds.
Key Properties:
-
FeedName(Key, Required) - Name of the artifact feed -
ProjectName(Key, Required) - Name of the project (or '@' for organization scope) -
FeedDescription(Optional) - Description of the feed -
Ensure(Optional) - Ensure presence or absence
Manages artifact feed permissions.
Key Properties:
-
FeedName(Key, Required) - Name of the feed -
ProjectName(Key, Required) - Name of the project -
IdentityName(Key, Required) - Name of the identity/group -
Role(Optional) - Role for the identity
Configures artifact feed settings.
Key Properties:
-
FeedName(Key, Required) - Name of the feed -
ProjectName(Key, Required) - Name of the project - Various feed settings properties
Manages artifact feed views.
Key Properties:
-
ViewName(Key, Required) - Name of the view -
FeedName(Key, Required) - Name of the feed -
ProjectName(Key, Required) - Name of the project -
Ensure(Optional) - Ensure presence or absence
(Listed under Permissions & Security above)
Configures branch protection policies and code policies.
Manages project wikis.
Key Properties:
-
WikiName(Key, Required) - Name of the wiki -
ProjectName(Key, Required) - Name of the project -
WikiType(Optional) - Type of wiki ('ProjectWiki', 'CodeWiki') -
Ensure(Optional) - Ensure presence or absence
Creates and manages task groups.
Key Properties:
-
TaskGroupName(Key, Required) - Name of the task group -
ProjectName(Key, Required) - Name of the project -
TaskGroupDescription(Optional) - Description -
Ensure(Optional) - Ensure presence or absence
Manages Azure DevOps extensions.
Key Properties:
-
ExtensionId(Key, Required) - ID of the extension -
ExtensionName(Key, Required) - Name of the extension -
Ensure(Optional) - Ensure presence or absence
Configures audit stream settings.
Key Properties:
-
StreamName(Key, Required) - Name of the audit stream -
Ensure(Optional) - Ensure presence or absence
Manages notification subscriptions.
Key Properties:
-
SubscriptionName(Key, Required) - Name of the subscription -
ProjectName(Key, Required) - Name of the project - Various subscription settings properties
-
Ensure(Optional) - Ensure presence or absence
Creates and manages service hooks (webhooks).
Key Properties:
-
ServiceHookName(Key, Required) - Name of the service hook -
ProjectName(Key, Required) - Name of the project -
EventType(Required) - Type of event to trigger on -
TargetUrl(Required) - URL to send webhook events to -
Ensure(Optional) - Ensure presence or absence
Creates and manages custom processes.
Key Properties:
-
ProcessName(Key, Required) - Name of the process -
ProcessDescription(Optional) - Description of the process -
Ensure(Optional) - Ensure presence or absence
Manages process permissions.
Key Properties:
-
ProcessName(Key, Required) - Name of the process -
IdentityName(Key, Required) - Name of the identity/group -
PermissionName(Key, Required) - Name of the permission
Manages Work-In-Progress (WIP) tags.
Key Properties:
-
TagName(Key, Required) - Name of the WIP tag -
ProjectName(Key, Required) - Name of the project -
Ensure(Optional) - Ensure presence or absence
Most DSC resources in AzureDevOpsDscNative support the following common properties:
| Property | Type | Required | Description |
|---|---|---|---|
Ensure |
String | No | 'Present' or 'Absent' - desired state of the resource |
Credential |
PSCredential | No | Credentials for authentication (if not using other auth methods) |
DependsOn |
String[] | No | Resources this depends on |
PsDscRunAsCredential |
PSCredential | No | Credentials to run configuration as |
- Choose the resource that matches your Azure DevOps management need
- Click the "View Full Documentation" link for detailed examples and all properties
- Review the Authentication Guide to set up proper authentication
- Check Examples for real-world scenarios
- Refer to Best Practices for optimization tips
- Review resource-specific documentation for detailed property descriptions
- Check the Examples page for practical scenarios
- Visit the Authentication Guide if you have auth issues
- See Best Practices for optimization and troubleshooting