Registration Definitions - Create Or Update

Referenz

Dienst:: Managed Services

API-Version:: 2022-10-01

Erstellt oder aktualisiert eine Registrierungsdefinition.

PUT 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	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
plan	Plan	Die Details für den Plan des Managed Services-Angebots in Azure Marketplace.
properties	RegistrationDefinitionProperties	Die Eigenschaften einer Registrierungsdefinition.

Antworten

Name	Typ	Beschreibung
200 OK	RegistrationDefinition	Ok – Gibt Informationen zur aktualisierten Registrierungsdefinition zurück.
201 Created	RegistrationDefinition	Erstellt – Gibt Informationen zur erstellten Registrierungsdefinition zurück.
Other Status Codes	ErrorResponse	Die Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Der Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Put Registration Definition

Beispielanforderung

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

{
  "properties": {
    "registrationDefinitionName": "DefinitionName",
    "description": "Tes1t",
    "managedByTenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
    "authorizations": [
      {
        "principalId": "f98d86a2-4cc4-4e9d-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": [
      {
        "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2",
        "principalIdDisplayName": "Support User",
        "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e",
        "justInTimeAccessPolicy": {
          "multiFactorAuthProvider": "Azure",
          "maximumActivationDuration": "PT8H",
          "managedByTenantApprovers": [
            {
              "principalId": "d9b22cd6-6407-43cc-8c60-07c56df0b51a",
              "principalIdDisplayName": "Approver Group"
            }
          ]
        }
      }
    ]
  },
  "plan": {
    "name": "addesai-plan",
    "product": "test",
    "publisher": "marketplace-test",
    "version": "1.0.0"
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.managedservices import ManagedServicesClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-managedservices
# USAGE
    python put_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.begin_create_or_update(
        registration_definition_id="26c128c2-fefa-4340-9bb1-6e081c90ada2",
        scope="subscription/0afefe50-734e-4610-8a82-a144ahf49dea",
        request_body={
            "plan": {"name": "addesai-plan", "product": "test", "publisher": "marketplace-test", "version": "1.0.0"},
            "properties": {
                "authorizations": [
                    {
                        "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
                        "principalIdDisplayName": "Support User",
                        "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7",
                    },
                    {
                        "delegatedRoleDefinitionIds": ["b24988ac-6180-42a0-ab88-20f7382dd24c"],
                        "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
                        "principalIdDisplayName": "User Access Administrator",
                        "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
                    },
                ],
                "description": "Tes1t",
                "eligibleAuthorizations": [
                    {
                        "justInTimeAccessPolicy": {
                            "managedByTenantApprovers": [
                                {
                                    "principalId": "d9b22cd6-6407-43cc-8c60-07c56df0b51a",
                                    "principalIdDisplayName": "Approver Group",
                                }
                            ],
                            "maximumActivationDuration": "PT8H",
                            "multiFactorAuthProvider": "Azure",
                        },
                        "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2",
                        "principalIdDisplayName": "Support User",
                        "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e",
                    }
                ],
                "managedByTenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
                "registrationDefinitionName": "DefinitionName",
            },
        },
    ).result()
    print(response)


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

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

// Generated from example definition: specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2022-10-01/examples/PutRegistrationDefinition.json
// this example is just showing the usage of "RegistrationDefinitions_CreateOrUpdate" 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 ManagedServicesRegistrationResource created on azure
// for more information of creating ManagedServicesRegistrationResource, please refer to the document of ManagedServicesRegistrationResource
string scope = "subscription/0afefe50-734e-4610-8a82-a144ahf49dea";
string registrationId = "26c128c2-fefa-4340-9bb1-6e081c90ada2";
ResourceIdentifier managedServicesRegistrationResourceId = ManagedServicesRegistrationResource.CreateResourceIdentifier(scope, registrationId);
ManagedServicesRegistrationResource managedServicesRegistration = client.GetManagedServicesRegistrationResource(managedServicesRegistrationResourceId);

// invoke the operation
ManagedServicesRegistrationData data = new ManagedServicesRegistrationData
{
    Properties = new ManagedServicesRegistrationProperties(new ManagedServicesAuthorization[]
{
new ManagedServicesAuthorization(Guid.Parse("f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc"), "acdd72a7-3385-48ef-bd42-f606fba81ae7")
{
PrincipalIdDisplayName = "Support User",
},
new ManagedServicesAuthorization(Guid.Parse("f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc"), "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9")
{
PrincipalIdDisplayName = "User Access Administrator",
DelegatedRoleDefinitionIds = {Guid.Parse("b24988ac-6180-42a0-ab88-20f7382dd24c")},
}
}, Guid.Parse("83abe5cd-bcc3-441a-bd86-e6a75360cecc"))
    {
        Description = "Tes1t",
        EligibleAuthorizations = {new ManagedServicesEligibleAuthorization(Guid.Parse("3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2"), "ae349356-3a1b-4a5e-921d-050484c6347e")
        {
        PrincipalIdDisplayName = "Support User",
        JustInTimeAccessPolicy = new ManagedServicesJustInTimeAccessPolicy(MultiFactorAuthProvider.Azure)
        {
        MaximumActivationDuration = XmlConvert.ToTimeSpan("PT8H"),
        ManagedByTenantApprovers = {new ManagedServicesEligibleApprover(Guid.Parse("d9b22cd6-6407-43cc-8c60-07c56df0b51a"))
        {
        PrincipalIdDisplayName = "Approver Group",
        }},
        },
        }},
        RegistrationDefinitionName = "DefinitionName",
    },
    Plan = new ManagedServicesPlan("addesai-plan", "marketplace-test", "test", "1.0.0"),
};
ArmOperation<ManagedServicesRegistrationResource> lro = await managedServicesRegistration.UpdateAsync(WaitUntil.Completed, data);
ManagedServicesRegistrationResource result = lro.Value;

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "properties": {
    "description": "Test",
    "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
    "registrationDefinitionName": "DefinitionName",
    "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",
    "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"
}

Statuscode:: 201

{
  "properties": {
    "description": "Test",
    "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc",
    "registrationDefinitionName": "DefinitionName",
    "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",
    "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 für 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 Prinzipal genehmigen kann, der in der "EligibleAuthorization" definiert ist.
EligibleAuthorization	Die Azure Active Directory-Prinzipal-ID, die integrierte Azure-Rolle und die Just-in-Time-Zugriffsrichtlinie, die den Just-in-Time-Zugriff beschreibt, den der Prinzipal für die delegierte Ressource im verwalteten Mandanten erhält.
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 für den Plan des Managed Services-Angebots in Azure Marketplace.
ProvisioningState	Der aktuelle Bereitstellungsstatus der Registrierungsdefinition.
RegistrationDefinition	Die Registrierungsdefinition.
RegistrationDefinitionProperties	Die Eigenschaften einer Registrierungsdefinition.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.

Authorization

Objekt

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

Name	Typ	Beschreibung
delegatedRoleDefinitionIds	string[] (uuid)	Das feld "delegatedRoleDefinitionIds" ist erforderlich, wenn die roleDefinitionId auf die Benutzerzugriffsadministratorrolle verweist. Es handelt sich um die Liste der Rollendefinitions-IDs, die alle Berechtigungen definieren, die der Benutzer in der Autorisierung anderen Prinzipale 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 aufweist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

EligibleApprover

Objekt

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

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

EligibleAuthorization

Objekt

Die Azure Active Directory-Prinzipal-ID, die integrierte Azure-Rolle und die Just-in-Time-Zugriffsrichtlinie, die den Just-in-Time-Zugriff beschreibt, den der Prinzipal für die delegierte Ressource im verwalteten Mandanten erhält.

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 aufweist.

ErrorDefinition

Objekt

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

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorDefinition	Die Fehlerdetails.

JustInTimeAccessPolicy

Objekt

Just-in-Time-Zugriffsrichtlinieneinstellung.

Name	Typ	Standardwert	Beschreibung
managedByTenantApprovers	EligibleApprover[]		Die Liste der genehmigen Genehmiger von managedByTenant für die berechtigte Autorisierung.
maximumActivationDuration	string (duration)	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

Enumeration

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

Wert	Beschreibung
Azure
None

Plan

Objekt

Die Details für den Plan des Managed Services-Angebots in Azure Marketplace.

Name	Typ	Beschreibung
name	string	Name des Azure Marketplace-Plans.
product	string	Azure Marketplace-Produktcode.
publisher	string	Azure Marketplace-Herausgeber-ID.
version	string	Version des Azure Marketplace-Plans.

ProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus der Registrierungsdefinition.

Wert	Beschreibung
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
NotSpecified
Ready
Running
Succeeded
Updating