Registration Definitions - Get

Service:

Managed Services

API Version:

2022-10-01

Ruft die Registrierungsdefinitionsdetails ab.

GET https://management.azure.com/{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}?api-version=2022-10-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
registrationDefinitionId	path	True	string	Die GUID der Registrierungsdefinition.
scope	path	True	string	Der Bereich der Ressource.
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	RegistrationDefinition	OK: Gibt die vollständige Registrierungsdefinition mit Plandetails zurück.
Other Status Codes	ErrorResponse	Die Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Der Azure Active Directory OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Get Registration Definition

Sample Request

HTTP

GET https://management.azure.com/subscription/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2?api-version=2022-10-01

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.managedservices import ManagedServicesClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-managedservices
# USAGE
    python get_registration_definition.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 = ManagedServicesClient(
        credential=DefaultAzureCredential(),
    )

    response = client.registration_definitions.get(
        scope="subscription/0afefe50-734e-4610-8a82-a144ahf49dea",
        registration_definition_id="26c128c2-fefa-4340-9bb1-6e081c90ada2",
    )
    print(response)


# x-ms-original-file: specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2022-10-01/examples/GetRegistrationDefinition.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

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ManagedServices;
using Azure.ResourceManager.ManagedServices.Models;

// Generated from example definition: specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2022-10-01/examples/GetRegistrationDefinition.json
// this example is just showing the usage of "RegistrationDefinitions_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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource

// get the collection of this ManagedServicesRegistrationResource
string scope = "subscription/0afefe50-734e-4610-8a82-a144ahf49dea";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
ManagedServicesRegistrationCollection collection = client.GetManagedServicesRegistrations(scopeId);

// invoke the operation
string registrationId = "26c128c2-fefa-4340-9bb1-6e081c90ada2";
NullableResponse<ManagedServicesRegistrationResource> response = await collection.GetIfExistsAsync(registrationId);
ManagedServicesRegistrationResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // 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
    ManagedServicesRegistrationData 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

Status code:

200

{
  "properties": {
    "description": "Test",
    "registrationDefinitionName": "DefinitionName",
    "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
    "authorizations": [
      {
        "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
        "principalIdDisplayName": "Support User",
        "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
      },
      {
        "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
        "principalIdDisplayName": "User Access Administrator",
        "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
        "delegatedRoleDefinitionIds": [
          "b24988ac-6180-42a0-ab88-20f7382dd24c"
        ]
      }
    ],
    "eligibleAuthorizations": [
      {
        "justInTimeAccessPolicy": {
          "multiFactorAuthProvider": "Azure",
          "maximumActivationDuration": "PT8H",
          "managedByTenantApprovers": [
            {
              "principalId": "d9b22cd6-6407-43cc-8c60-07c56df0b51a",
              "principalIdDisplayName": "Approver Group"
            }
          ]
        },
        "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2",
        "principalIdDisplayName": "Support User",
        "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e"
      }
    ],
    "provisioningState": "Succeeded",
    "manageeTenantId": "0e06d6a3-55ae-40a3-ac29-350808980808",
    "manageeTenantName": "Test customer",
    "managedByTenantName": "Test Tenant"
  },
  "plan": {
    "name": "addesai-plan",
    "product": "test",
    "publisher": "marketplace-test",
    "version": "1.0.0"
  },
  "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2",
  "type": "Microsoft.ManagedServices/registrationDefinitions",
  "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2"
}

Definitionen

Name	Beschreibung
Authorization	Der Azure Active Directory-Prinzipalbezeichner und die integrierte Azure-Rolle, die den Zugriff beschreibt, den der Prinzipal auf die delegierte Ressource im verwalteten Mandanten erhält.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
EligibleApprover	Definiert den Azure Active Directory-Prinzipal, der alle Just-in-Time-Zugriffsanforderungen durch den in der EligibleAuthorization definierten Prinzipal genehmigen kann.
EligibleAuthorization	Der Azure Active Directory-Prinzipalbezeichner, die integrierte Azure-Rolle und die Just-in-Time-Zugriffsrichtlinie, die den Just-in-Time-Zugriff beschreibt, den der Prinzipal auf die delegierte Ressource im verwalteten Mandanten empfängt.
ErrorDefinition	Die Fehlerantwort, die angibt, warum die eingehende Anforderung nicht verarbeitet werden konnte
ErrorResponse	Fehlerantwort.
JustInTimeAccessPolicy	Just-in-Time-Zugriffsrichtlinieneinstellung.
MultiFactorAuthProvider	Der mehrstufige Autorisierungsanbieter, der für Just-in-Time-Zugriffsanforderungen verwendet werden soll.
Plan	Die Details zum Plan des Managed Services-Angebots in Azure Marketplace.
ProvisioningState	Der aktuelle Bereitstellungsstatus der Registrierungsdefinition.
RegistrationDefinition	Die Registrierungsdefinition.
RegistrationDefinitionProperties	Die Eigenschaften einer Registrierungsdefinition.
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Authorization

Der Azure Active Directory-Prinzipalbezeichner und die integrierte Azure-Rolle, die den Zugriff beschreibt, den der Prinzipal auf die delegierte Ressource im verwalteten Mandanten erhält.

Name	Typ	Beschreibung
delegatedRoleDefinitionIds	string[]	Das Feld delegierteRoleDefinitionIds ist erforderlich, wenn roleDefinitionId auf die Rolle "Benutzerzugriffsadministrator" verweist. Dies ist die Liste der Rollendefinitions-IDs, die alle Berechtigungen definieren, die der Benutzer in der Autorisierung anderen Prinzipalen zuweisen kann.
principalId	string	Der Bezeichner des Azure Active Directory-Prinzipals.
principalIdDisplayName	string	Der Anzeigename des Azure Active Directory-Prinzipals.
roleDefinitionId	string	Der Bezeichner der integrierten Azure-Rolle, die die Berechtigungen definiert, die der Azure Active Directory-Prinzipal für den projizierten Bereich besitzt.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

EligibleApprover

Definiert den Azure Active Directory-Prinzipal, der alle Just-in-Time-Zugriffsanforderungen durch den in der EligibleAuthorization definierten Prinzipal genehmigen kann.

Name	Typ	Beschreibung
principalId	string	Der Bezeichner des Azure Active Directory-Prinzipals.
principalIdDisplayName	string	Der Anzeigename des Azure Active Directory-Prinzipals.

EligibleAuthorization

Der Azure Active Directory-Prinzipalbezeichner, die integrierte Azure-Rolle und die Just-in-Time-Zugriffsrichtlinie, die den Just-in-Time-Zugriff beschreibt, den der Prinzipal auf die delegierte Ressource im verwalteten Mandanten empfängt.

Name	Typ	Beschreibung
justInTimeAccessPolicy	JustInTimeAccessPolicy	Die Just-in-Time-Zugriffsrichtlinieneinstellung.
principalId	string	Der Bezeichner des Azure Active Directory-Prinzipals.
principalIdDisplayName	string	Der Anzeigename des Azure Active Directory-Prinzipals.
roleDefinitionId	string	Der Bezeichner der integrierten Azure-Rolle, die die Berechtigungen definiert, die der Azure Active Directory-Prinzipal für den projizierten Bereich besitzt.

ErrorDefinition

Die Fehlerantwort, die angibt, warum die eingehende Anforderung nicht verarbeitet werden konnte

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	ErrorDefinition[]	Die internen Fehlerdetails.
message	string	Die Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDefinition	Die Fehlerdetails.

JustInTimeAccessPolicy

Just-in-Time-Zugriffsrichtlinieneinstellung.

Name	Typ	Standardwert	Beschreibung
managedByTenantApprovers	EligibleApprover[]		Die Liste der genehmigenden managedByTenant-Personen für die berechtigte Autorisierung.
maximumActivationDuration	string	PT8H	Die maximale Zugriffsdauer im ISO 8601-Format für Just-in-Time-Zugriffsanforderungen.
multiFactorAuthProvider	MultiFactorAuthProvider	None	Der mehrstufige Autorisierungsanbieter, der für Just-in-Time-Zugriffsanforderungen verwendet werden soll.

MultiFactorAuthProvider

Der mehrstufige Autorisierungsanbieter, der für Just-in-Time-Zugriffsanforderungen verwendet werden soll.

Name	Typ	Beschreibung
Azure	string
None	string

Plan

Die Details zum Plan des Managed Services-Angebots in Azure Marketplace.

Name	Typ	Beschreibung
name	string	Azure Marketplace Planname.
product	string	Azure Marketplace Produktcode.
publisher	string	Azure Marketplace Herausgeber-ID.
version	string	Azure Marketplace Planversion.

ProvisioningState

Der aktuelle Bereitstellungsstatus der Registrierungsdefinition.

Name	Typ	Beschreibung
Accepted	string
Canceled	string
Created	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Ready	string
Running	string
Succeeded	string
Updating	string

RegistrationDefinition

Die Registrierungsdefinition.

Name	Typ	Beschreibung
id	string	Der vollqualifizierte Pfad der Registrierungsdefinition.
name	string	Der Name der Registrierungsdefinition.
plan	Plan	Die Details zum Plan des Managed Services-Angebots in Azure Marketplace.
properties	RegistrationDefinitionProperties	Die Eigenschaften einer Registrierungsdefinition.
systemData	systemData	Die Metadaten für die Registrierungszuweisungsressource.
type	string	Der Typ der Azure-Ressource (Microsoft.ManagedServices/registrationDefinitions).

RegistrationDefinitionProperties

Die Eigenschaften einer Registrierungsdefinition.

Name	Typ	Beschreibung
authorizations	Authorization[]	Die Sammlung von Autorisierungsobjekten, die die Azure Active Directory-Zugriffsprinzipale im managedBy-Mandanten beschreiben, wird für die delegierte Ressource im verwalteten Mandanten empfangen.
description	string	Die Beschreibung der Registrierungsdefinition.
eligibleAuthorizations	EligibleAuthorization[]	Die Auflistung berechtigter Autorisierungsobjekte, die die Azure Active Directory-Prinzipale für den Just-in-Time-Zugriff im managedBy-Mandanten beschreiben, wird für die delegierte Ressource im verwalteten Mandanten empfangen.
managedByTenantId	string	Der Bezeichner des managedBy-Mandanten.
managedByTenantName	string	Der Name des managedBy-Mandanten.
manageeTenantId	string	Der Bezeichner des verwalteten Mandanten.
manageeTenantName	string	Der Name des verwalteten Mandanten.
provisioningState	ProvisioningState	Der aktuelle Bereitstellungsstatus der Registrierungsdefinition.
registrationDefinitionName	string	Der Name der Registrierungsdefinition.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.