Get the specified deny assignment.
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}?api-version=2022-04-01
URI Parameters
Name |
In |
Required |
Type |
Description |
denyAssignmentId
|
path |
True
|
string
|
The ID of the deny assignment to get.
|
scope
|
path |
True
|
string
|
The scope of the deny assignment.
|
api-version
|
query |
True
|
string
|
The API version to use for this operation.
|
Responses
Name |
Type |
Description |
200 OK
|
DenyAssignment
|
OK - Returns information about the deny assignment.
|
Other Status Codes
|
ErrorResponse
|
Error response describing why the operation failed.
|
Permissions
To call this API, you must be assigned a role that has the following permissions. For more information, see Azure built-in roles.
Microsoft.Authorization/denyAssignments/read
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name |
Description |
user_impersonation
|
impersonate your user account
|
Examples
Get deny assignment by name
Sample request
GET https://management.azure.com/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/denyAssignments/denyAssignmentId?api-version=2022-04-01
/**
* Samples for DenyAssignments Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/
* GetDenyAssignmentByNameId.json
*/
/**
* Sample code: Get deny assignment by name.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void getDenyAssignmentByName(com.azure.resourcemanager.AzureResourceManager azure) {
azure.accessManagement().roleAssignments().manager().roleServiceClient().getDenyAssignments().getWithResponse(
"subscriptions/subId/resourcegroups/rgname", "denyAssignmentId", com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.authorization import AuthorizationManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-authorization
# USAGE
python get_deny_assignment_by_name_id.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = AuthorizationManagementClient(
credential=DefaultAzureCredential(),
subscription_id="SUBSCRIPTION_ID",
)
response = client.deny_assignments.get(
scope="subscriptions/subId/resourcegroups/rgname",
deny_assignment_id="denyAssignmentId",
)
print(response)
# x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByNameId.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armauthorization_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/authorization/armauthorization/v3"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/310a0100f5b020c1900c527a6aa70d21992f078a/specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByNameId.json
func ExampleDenyAssignmentsClient_Get() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armauthorization.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewDenyAssignmentsClient().Get(ctx, "subscriptions/subId/resourcegroups/rgname", "denyAssignmentId", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.DenyAssignment = armauthorization.DenyAssignment{
// Name: to.Ptr("denyAssignmentId"),
// Type: to.Ptr("Microsoft.Authorization/denyAssignments"),
// ID: to.Ptr("/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/denyAssignments/denyAssignmentId"),
// Properties: &armauthorization.DenyAssignmentProperties{
// Description: to.Ptr("Deny assignment description"),
// DenyAssignmentName: to.Ptr("Deny assignment name"),
// DoNotApplyToChildScopes: to.Ptr(false),
// ExcludePrincipals: []*armauthorization.Principal{
// {
// Type: to.Ptr("principalType2"),
// ID: to.Ptr("principalId2"),
// }},
// IsSystemProtected: to.Ptr(true),
// Permissions: []*armauthorization.DenyAssignmentPermission{
// {
// Actions: []*string{
// to.Ptr("action")},
// DataActions: []*string{
// },
// NotActions: []*string{
// },
// NotDataActions: []*string{
// },
// }},
// Principals: []*armauthorization.Principal{
// {
// Type: to.Ptr("principalType1"),
// ID: to.Ptr("principalId1"),
// }},
// Scope: to.Ptr("/subscriptions/subId/resourcegroups/rgname"),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { AuthorizationManagementClient } = require("@azure/arm-authorization");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Get the specified deny assignment.
*
* @summary Get the specified deny assignment.
* x-ms-original-file: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByNameId.json
*/
async function getDenyAssignmentByName() {
const scope = "subscriptions/subId/resourcegroups/rgname";
const denyAssignmentId = "denyAssignmentId";
const credential = new DefaultAzureCredential();
const client = new AuthorizationManagementClient(credential);
const result = await client.denyAssignments.get(scope, denyAssignmentId);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Authorization;
// Generated from example definition: specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/examples/GetDenyAssignmentByNameId.json
// this example is just showing the usage of "DenyAssignments_Get" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this DenyAssignmentResource created on azure
// for more information of creating DenyAssignmentResource, please refer to the document of DenyAssignmentResource
string scope = "subscriptions/subId/resourcegroups/rgname";
string denyAssignmentId = "denyAssignmentId";
ResourceIdentifier denyAssignmentResourceId = DenyAssignmentResource.CreateResourceIdentifier(scope, denyAssignmentId);
DenyAssignmentResource denyAssignment = client.GetDenyAssignmentResource(denyAssignmentResourceId);
// invoke the operation
DenyAssignmentResource result = await denyAssignment.GetAsync();
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DenyAssignmentData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample response
{
"properties": {
"denyAssignmentName": "Deny assignment name",
"description": "Deny assignment description",
"permissions": [
{
"actions": [
"action"
],
"notActions": [],
"dataActions": [],
"notDataActions": []
}
],
"scope": "/subscriptions/subId/resourcegroups/rgname",
"doNotApplyToChildScopes": false,
"principals": [
{
"id": "principalId1",
"type": "principalType1"
}
],
"excludePrincipals": [
{
"id": "principalId2",
"type": "principalType2"
}
],
"isSystemProtected": true
},
"id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/denyAssignments/denyAssignmentId",
"type": "Microsoft.Authorization/denyAssignments",
"name": "denyAssignmentId"
}
Definitions
DenyAssignment
Deny Assignment
Name |
Type |
Description |
id
|
string
|
The deny assignment ID.
|
name
|
string
|
The deny assignment name.
|
properties.condition
|
string
|
The conditions on the deny assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
|
properties.conditionVersion
|
string
|
Version of the condition.
|
properties.createdBy
|
string
|
Id of the user who created the assignment
|
properties.createdOn
|
string
|
Time it was created
|
properties.denyAssignmentName
|
string
|
The display name of the deny assignment.
|
properties.description
|
string
|
The description of the deny assignment.
|
properties.doNotApplyToChildScopes
|
boolean
|
Determines if the deny assignment applies to child scopes. Default value is false.
|
properties.excludePrincipals
|
Principal[]
|
Array of principals to which the deny assignment does not apply.
|
properties.isSystemProtected
|
boolean
|
Specifies whether this deny assignment was created by Azure and cannot be edited or deleted.
|
properties.permissions
|
DenyAssignmentPermission[]
|
An array of permissions that are denied by the deny assignment.
|
properties.principals
|
Principal[]
|
Array of principals to which the deny assignment applies.
|
properties.scope
|
string
|
The deny assignment scope.
|
properties.updatedBy
|
string
|
Id of the user who updated the assignment
|
properties.updatedOn
|
string
|
Time it was updated
|
type
|
string
|
The deny assignment type.
|
DenyAssignmentPermission
Deny assignment permissions.
Name |
Type |
Description |
actions
|
string[]
|
Actions to which the deny assignment does not grant access.
|
condition
|
string
|
The conditions on the Deny assignment permission. This limits the resources it applies to.
|
conditionVersion
|
string
|
Version of the condition.
|
dataActions
|
string[]
|
Data actions to which the deny assignment does not grant access.
|
notActions
|
string[]
|
Actions to exclude from that the deny assignment does not grant access.
|
notDataActions
|
string[]
|
Data actions to exclude from that the deny assignment does not grant access.
|
ErrorAdditionalInfo
The resource management error additional info.
Name |
Type |
Description |
info
|
object
|
The additional info.
|
type
|
string
|
The additional info type.
|
ErrorDetail
The error detail.
Name |
Type |
Description |
additionalInfo
|
ErrorAdditionalInfo[]
|
The error additional info.
|
code
|
string
|
The error code.
|
details
|
ErrorDetail[]
|
The error details.
|
message
|
string
|
The error message.
|
target
|
string
|
The error target.
|
ErrorResponse
Error response
Name |
Type |
Description |
error
|
ErrorDetail
|
The error object.
|
Principal
The name of the entity last modified it
Name |
Type |
Description |
displayName
|
string
|
The name of the principal made changes
|
email
|
string
|
Email of principal
|
id
|
string
|
The id of the principal made changes
|
type
|
string
|
Type of principal such as user , group etc
|