Deny Assignments - Get

Dienst:

Authorization

API-Version:

2022-04-01

Rufen Sie die angegebene Deny-Zuweisung ab.

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}?api-version=2022-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
denyAssignmentId	path	True	string	Die ID der abzurufenden Zuweisung verweigern.
scope	path	True	string	Der Bereich der Ablehnungszuweisung.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	DenyAssignment	OK: Gibt Informationen zur Ablehnungszuweisung zurück.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Berechtigungen

Ihnen muss eine Rolle mit den folgenden Berechtigungen zugewiesen sein, damit Sie diese API aufrufen können. Weitere Informationen finden Sie unter Integrierte Azure-Rollen.

Microsoft.Authorization/denyAssignments/read

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get deny assignment by name

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/denyAssignments/denyAssignmentId?api-version=2022-04-01

Java

/**
 * 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

Python

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

Go

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

JavaScript

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

dotnet

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

Beispiel für eine Antwort

Statuscode:

200

{
  "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"
}

Definitionen

Name	Beschreibung
DenyAssignment	Ablehnungszuweisung
DenyAssignmentPermission	Zuweisungsberechtigungen verweigern.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
Principal	Der Name der Entität, die sie zuletzt geändert hat

DenyAssignment

Ablehnungszuweisung

Name	Typ	Beschreibung
id	string	Die Ablehnungszuweisungs-ID.
name	string	Der Name der Ablehnungszuweisung.
properties.condition	string	Die Bedingungen für die Ablehnungszuweisung. Dies schränkt die Ressourcen ein, denen sie zugewiesen werden kann. Beispiel: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'
properties.conditionVersion	string	Version der Bedingung.
properties.createdBy	string	ID des Benutzers, der die Zuweisung erstellt hat
properties.createdOn	string	Erstellungszeit
properties.denyAssignmentName	string	Der Anzeigename der Ablehnungszuweisung.
properties.description	string	Die Beschreibung der Ablehnungszuweisung.
properties.doNotApplyToChildScopes	boolean	Bestimmt, ob die Ablehnungszuweisung für untergeordnete Bereiche gilt. Der Standardwert ist „false“.
properties.excludePrincipals	Principal[]	Array von Prinzipalen, für die die Ablehnungszuweisung nicht gilt.
properties.isSystemProtected	boolean	Gibt an, ob diese Ablehnungszuweisung von Azure erstellt wurde und nicht bearbeitet oder gelöscht werden kann.
properties.permissions	DenyAssignmentPermission[]	Ein Array von Berechtigungen, die von der Ablehnungszuweisung verweigert werden.
properties.principals	Principal[]	Array von Prinzipalen, für die die Ablehnungszuweisung gilt.
properties.scope	string	Der Ablehnungszuweisungsbereich.
properties.updatedBy	string	ID des Benutzers, der die Zuweisung aktualisiert hat
properties.updatedOn	string	Aktualisierungszeit
type	string	Der Zuweisungstyp deny.

DenyAssignmentPermission

Zuweisungsberechtigungen verweigern.

Name	Typ	Beschreibung
actions	string[]	Aktionen, auf die die Ablehnungszuweisung keinen Zugriff gewährt.
condition	string	Die Bedingungen für die Berechtigung Zuweisung verweigern. Dies schränkt die Ressourcen ein, für die er gilt.
conditionVersion	string	Version der Bedingung.
dataActions	string[]	Datenaktionen, auf die die Ablehnungszuweisung keinen Zugriff gewährt.
notActions	string[]	Aktionen, um davon auszuschließen, dass die Ablehnungszuweisung keinen Zugriff gewährt.
notDataActions	string[]	Datenaktionen, um davon auszuschließen, dass die Ablehnungszuweisung keinen Zugriff gewährt.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Principal

Der Name der Entität, die sie zuletzt geändert hat

Name	Typ	Beschreibung
displayName	string	Der Name des Prinzipals, der Änderungen vorgenommen hat
email	string	Email des Prinzipals
id	string	Die ID des Prinzipals, der Änderungen vorgenommen hat
type	string	Prinzipaltyp wie Benutzer, Gruppe usw.