com.azure.resourcemanager.security.fluent.GovernanceAssignmentsClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-security Show documentation
This package contains Microsoft Azure SDK for Security Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. API spec for Microsoft.Security (Azure Security Center) resource provider. Package tag package-composite-v3.
There is a newer version: 1.0.0
Show newest version
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.security.fluent;

import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import com.azure.resourcemanager.security.fluent.models.GovernanceAssignmentInner;

/**
 * An instance of this class provides access to all the operations defined in GovernanceAssignmentsClient.
 */
public interface GovernanceAssignmentsClient {
    /**
     * Get governance assignments on all of your resources inside a scope.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return governance assignments on all of your resources inside a scope as paginated response with
     * {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable list(String scope, String assessmentName);

    /**
     * Get governance assignments on all of your resources inside a scope.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return governance assignments on all of your resources inside a scope as paginated response with
     * {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable list(String scope, String assessmentName, Context context);

    /**
     * Get a specific governanceAssignment for the requested scope by AssignmentKey.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param assignmentKey The governance assignment key - the assessment key of the required governance assignment.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a specific governanceAssignment for the requested scope by AssignmentKey along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response getWithResponse(String scope, String assessmentName, String assignmentKey,
        Context context);

    /**
     * Get a specific governanceAssignment for the requested scope by AssignmentKey.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param assignmentKey The governance assignment key - the assessment key of the required governance assignment.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a specific governanceAssignment for the requested scope by AssignmentKey.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    GovernanceAssignmentInner get(String scope, String assessmentName, String assignmentKey);

    /**
     * Creates or updates a governance assignment on the given subscription.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param assignmentKey The governance assignment key - the assessment key of the required governance assignment.
     * @param governanceAssignment Governance assignment over a subscription scope.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return governance assignment over a given scope along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response createOrUpdateWithResponse(String scope, String assessmentName,
        String assignmentKey, GovernanceAssignmentInner governanceAssignment, Context context);

    /**
     * Creates or updates a governance assignment on the given subscription.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param assignmentKey The governance assignment key - the assessment key of the required governance assignment.
     * @param governanceAssignment Governance assignment over a subscription scope.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return governance assignment over a given scope.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    GovernanceAssignmentInner createOrUpdate(String scope, String assessmentName, String assignmentKey,
        GovernanceAssignmentInner governanceAssignment);

    /**
     * Delete a GovernanceAssignment over a given scope.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param assignmentKey The governance assignment key - the assessment key of the required governance assignment.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response deleteWithResponse(String scope, String assessmentName, String assignmentKey, Context context);

    /**
     * Delete a GovernanceAssignment over a given scope.
     * 
     * @param scope The scope of the Governance assignments. Valid scopes are: subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @param assessmentName The Assessment Key - A unique key for the assessment type.
     * @param assignmentKey The governance assignment key - the assessment key of the required governance assignment.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    void delete(String scope, String assessmentName, String assignmentKey);
}