com.azure.resourcemanager.security.models.StandardAssignments 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.models;

import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;

/**
 * Resource collection API of StandardAssignments.
 */
public interface StandardAssignments {
    /**
     * Retrieves a standard assignment.
     * 
     * This operation retrieves a single standard assignment, given its name and the scope it was created at.
     * 
     * @param resourceId The identifier of the resource.
     * @param standardAssignmentName The standard assignments assignment key - unique key for the standard 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 security Assignment on a resource group over a given scope along with {@link Response}.
     */
    Response getWithResponse(String resourceId, String standardAssignmentName, Context context);

    /**
     * Retrieves a standard assignment.
     * 
     * This operation retrieves a single standard assignment, given its name and the scope it was created at.
     * 
     * @param resourceId The identifier of the resource.
     * @param standardAssignmentName The standard assignments assignment key - unique key for the standard 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 security Assignment on a resource group over a given scope.
     */
    StandardAssignment get(String resourceId, String standardAssignmentName);

    /**
     * Deletes a standard assignment.
     * 
     * This operation deletes a standard assignment, given its name and the scope it was created in. The scope of a
     * standard assignment is the part of its ID preceding
     * '/providers/Microsoft.Security/standardAssignments/{standardAssignmentName}'.
     * 
     * @param resourceId The identifier of the resource.
     * @param standardAssignmentName The standard assignments assignment key - unique key for the standard 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}.
     */
    Response deleteByResourceGroupWithResponse(String resourceId, String standardAssignmentName, Context context);

    /**
     * Deletes a standard assignment.
     * 
     * This operation deletes a standard assignment, given its name and the scope it was created in. The scope of a
     * standard assignment is the part of its ID preceding
     * '/providers/Microsoft.Security/standardAssignments/{standardAssignmentName}'.
     * 
     * @param resourceId The identifier of the resource.
     * @param standardAssignmentName The standard assignments assignment key - unique key for the standard 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.
     */
    void deleteByResourceGroup(String resourceId, String standardAssignmentName);

    /**
     * Get a list of all relevant standard assignments over a scope.
     * 
     * @param scope The scope of the standard assignment. Valid scopes are: management group (format:
     * 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @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 list of all relevant standard assignments over a scope as paginated response with
     * {@link PagedIterable}.
     */
    PagedIterable list(String scope);

    /**
     * Get a list of all relevant standard assignments over a scope.
     * 
     * @param scope The scope of the standard assignment. Valid scopes are: management group (format:
     * 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format:
     * 'subscriptions/{subscriptionId}'), or security connector (format:
     * 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'.
     * @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 list of all relevant standard assignments over a scope as paginated response with
     * {@link PagedIterable}.
     */
    PagedIterable list(String scope, Context context);

    /**
     * Retrieves a standard assignment.
     * 
     * This operation retrieves a single standard assignment, given its name and the scope it was created at.
     * 
     * @param id the resource ID.
     * @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 security Assignment on a resource group over a given scope along with {@link Response}.
     */
    StandardAssignment getById(String id);

    /**
     * Retrieves a standard assignment.
     * 
     * This operation retrieves a single standard assignment, given its name and the scope it was created at.
     * 
     * @param id the resource ID.
     * @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 security Assignment on a resource group over a given scope along with {@link Response}.
     */
    Response getByIdWithResponse(String id, Context context);

    /**
     * Deletes a standard assignment.
     * 
     * This operation deletes a standard assignment, given its name and the scope it was created in. The scope of a
     * standard assignment is the part of its ID preceding
     * '/providers/Microsoft.Security/standardAssignments/{standardAssignmentName}'.
     * 
     * @param id the resource ID.
     * @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.
     */
    void deleteById(String id);

    /**
     * Deletes a standard assignment.
     * 
     * This operation deletes a standard assignment, given its name and the scope it was created in. The scope of a
     * standard assignment is the part of its ID preceding
     * '/providers/Microsoft.Security/standardAssignments/{standardAssignmentName}'.
     * 
     * @param id the resource ID.
     * @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}.
     */
    Response deleteByIdWithResponse(String id, Context context);

    /**
     * Begins definition for a new StandardAssignment resource.
     * 
     * @param name resource name.
     * @return the first stage of the new StandardAssignment definition.
     */
    StandardAssignment.DefinitionStages.Blank define(String name);
}