Registration Definitions - Create Or Update

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

HTTP

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

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
User
Application
ManagedIdentity
Key

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
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

RegistrationDefinition

Objekt

Die Registrierungsdefinition.

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

RegistrationDefinitionProperties

Objekt

Die Eigenschaften einer Registrierungsdefinition.

Name	Typ	Beschreibung
authorizations	Authorization[]	Die Sammlung von Autorisierungsobjekten, die den Zugriff auf Azure Active Directory-Prinzipale im managedBy-Mandanten beschreiben, erhält die delegierte Ressource im verwalteten Mandanten.
description	string	Die Beschreibung der Registrierungsdefinition.
eligibleAuthorizations	EligibleAuthorization[]	Die Sammlung berechtigter Autorisierungsobjekte, die den Just-in-Time-Zugriff azure Active Directory-Prinzipale im managedBy-Mandanten beschreiben, erhält die delegierte Ressource im verwalteten Mandanten.
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

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	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 (date-time)	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.