com.azure.security.keyvault.administration.models.KeyVaultRoleAssignmentProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-security-keyvault-administration Show documentation

This module contains client library for Microsoft Azure KeyVault Administration.

There is a newer version: 4.6.0

Show newest version

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.security.keyvault.administration.models;

import com.azure.core.annotation.Immutable;

/**
 * A class that defines a role assignment's properties.
 */
@Immutable
public final class KeyVaultRoleAssignmentProperties {
    private final String roleDefinitionId;
    private final String principalId;
    private final KeyVaultRoleScope scope;

    /**
     * Creates a new {@link KeyVaultRoleAssignmentProperties role assignment properties} object with the specified
     * details.
     *
     * @param roleDefinitionId The {@link KeyVaultRoleDefinition role definition} ID used in the
     * {@link KeyVaultRoleAssignment role assignment}.
     * @param principalId The principal ID assigned to the role. This maps to the ID inside the Active Directory.
     * It can point to a user, service principal, or security group.*
     * @param scope The {@link KeyVaultRoleScope scope} of this {@link KeyVaultRoleAssignment role assignment}.
     */
    public KeyVaultRoleAssignmentProperties(String roleDefinitionId, String principalId, KeyVaultRoleScope scope) {
        this.roleDefinitionId = roleDefinitionId;
        this.principalId = principalId;
        this.scope = scope;
    }

    /**
     * Get the {@link KeyVaultRoleDefinition role definition} ID used in the {@link KeyVaultRoleAssignment role
     * assignment}.
     *
     * @return The {@link KeyVaultRoleDefinition role definition} ID.
     */
    public String getRoleDefinitionId() {
        return roleDefinitionId;
    }

    /**
     * Get the principal ID assigned to the role.
     *
     * @return The principal ID.
     */
    public String getPrincipalId() {
        return principalId;
    }

    /**
     * Get the {@link KeyVaultRoleAssignment role assignment} {@link KeyVaultRoleScope scope}.
     *
     * @return The {@link KeyVaultRoleAssignment role assignment} {@link KeyVaultRoleScope scope}.
     */
    public KeyVaultRoleScope getScope() {
        return scope;
    }
}