azure.mgmt.managedservices.models module¶

class azure.mgmt.managedservices.models.Authorization(*, principal_id: str, role_definition_id: str, principal_id_display_name: Optional[str] = None, delegated_role_definition_ids: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The Azure Active Directory principal identifier and Azure built-in role that describes the access the principal will receive on the delegated resource in the managed tenant.

All required parameters must be populated in order to send to Azure.

Variables

principal_id (str) – The identifier of the Azure Active Directory principal. Required.
principal_id_display_name (str) – The display name of the Azure Active Directory principal.
role_definition_id (str) – The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. Required.
delegated_role_definition_ids (list[str]) – The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals.

Keyword Arguments

principal_id (str) – The identifier of the Azure Active Directory principal. Required.
principal_id_display_name (str) – The display name of the Azure Active Directory principal.
role_definition_id (str) – The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. Required.
delegated_role_definition_ids (list[str]) – The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals.

class azure.mgmt.managedservices.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.managedservices.models.EligibleApprover(*, principal_id: str, principal_id_display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

Defines the Azure Active Directory principal that can approve any just-in-time access requests by the principal defined in the EligibleAuthorization.

All required parameters must be populated in order to send to Azure.

Variables

principal_id (str) – The identifier of the Azure Active Directory principal. Required.
principal_id_display_name (str) – The display name of the Azure Active Directory principal.

Keyword Arguments

principal_id (str) – The identifier of the Azure Active Directory principal. Required.
principal_id_display_name (str) – The display name of the Azure Active Directory principal.

class azure.mgmt.managedservices.models.EligibleAuthorization(*, principal_id: str, role_definition_id: str, principal_id_display_name: Optional[str] = None, just_in_time_access_policy: Optional[_models.JustInTimeAccessPolicy] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The Azure Active Directory principal identifier, Azure built-in role, and just-in-time access policy that describes the just-in-time access the principal will receive on the delegated resource in the managed tenant.

All required parameters must be populated in order to send to Azure.

Variables

principal_id (str) – The identifier of the Azure Active Directory principal. Required.
principal_id_display_name (str) – The display name of the Azure Active Directory principal.
role_definition_id (str) – The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. Required.
just_in_time_access_policy (JustInTimeAccessPolicy) – The just-in-time access policy setting.

Keyword Arguments

principal_id (str) – The identifier of the Azure Active Directory principal. Required.
principal_id_display_name (str) – The display name of the Azure Active Directory principal.
role_definition_id (str) – The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. Required.
just_in_time_access_policy (JustInTimeAccessPolicy) – The just-in-time access policy setting.

class azure.mgmt.managedservices.models.ErrorDefinition(*, code: str, message: str, details: Optional[List[_models.ErrorDefinition]] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The error response indicating why the incoming request wasn’t able to be processed.

All required parameters must be populated in order to send to Azure.

Variables

code (str) – The error code. Required.
message (str) – The error message indicating why the operation failed. Required.
details (list[ErrorDefinition]) – The internal error details.

Keyword Arguments

code (str) – The error code. Required.
message (str) – The error message indicating why the operation failed. Required.
details (list[ErrorDefinition]) – The internal error details.

class azure.mgmt.managedservices.models.ErrorResponse(*, error: Optional[_models.ErrorDefinition] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

Error response.

Variables: error (ErrorDefinition) – The error details.
Keyword Arguments: error (ErrorDefinition) – The error details.

class azure.mgmt.managedservices.models.JustInTimeAccessPolicy(*, multi_factor_auth_provider: Union[str, _models.MultiFactorAuthProvider] = 'None', maximum_activation_duration: datetime.timedelta = 'PT8H', managed_by_tenant_approvers: Optional[List[_models.EligibleApprover]] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

Just-in-time access policy setting.

All required parameters must be populated in order to send to Azure.

Variables

multi_factor_auth_provider (str or MultiFactorAuthProvider) – The multi-factor authorization provider to be used for just-in-time access requests. Known values are: “Azure” and “None”.
maximum_activation_duration (timedelta) – The maximum access duration in ISO 8601 format for just-in-time access requests.
managed_by_tenant_approvers (list[EligibleApprover]) – The list of managedByTenant approvers for the eligible authorization.

Keyword Arguments

multi_factor_auth_provider (str or MultiFactorAuthProvider) – The multi-factor authorization provider to be used for just-in-time access requests. Known values are: “Azure” and “None”.
maximum_activation_duration (timedelta) – The maximum access duration in ISO 8601 format for just-in-time access requests.
managed_by_tenant_approvers (list[EligibleApprover]) – The list of managedByTenant approvers for the eligible authorization.

class azure.mgmt.managedservices.models.MarketplaceRegistrationDefinition(*, properties: Optional[_models.MarketplaceRegistrationDefinitionProperties] = None, plan: Optional[_models.Plan] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

MarketplaceRegistrationDefinition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

properties (MarketplaceRegistrationDefinitionProperties) – The properties of the marketplace registration definition.
plan (Plan) – The details for the Managed Services offer’s plan in Azure Marketplace.
id (str) – The fully qualified path of the marketplace registration definition.
type (str) – The type of the Azure resource (Microsoft.ManagedServices/marketplaceRegistrationDefinitions).
name (str) – The name of the marketplace registration definition.

Keyword Arguments

properties (MarketplaceRegistrationDefinitionProperties) – The properties of the marketplace registration definition.
plan (Plan) – The details for the Managed Services offer’s plan in Azure Marketplace.

class azure.mgmt.managedservices.models.MarketplaceRegistrationDefinitionList(**kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The list of marketplace registration definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[MarketplaceRegistrationDefinition]) – The list of marketplace registration definitions.
next_link (str) – The link to the next page of marketplace registration definitions.

class azure.mgmt.managedservices.models.MarketplaceRegistrationDefinitionProperties(*, managed_by_tenant_id: str, authorizations: List[_models.Authorization], eligible_authorizations: Optional[List[_models.EligibleAuthorization]] = None, offer_display_name: Optional[str] = None, publisher_display_name: Optional[str] = None, plan_display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The properties of the marketplace registration definition.

All required parameters must be populated in order to send to Azure.

Variables

managed_by_tenant_id (str) – The identifier of the managedBy tenant. Required.
authorizations (list[Authorization]) – The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. Required.
eligible_authorizations (list[EligibleAuthorization]) – The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
offer_display_name (str) – The marketplace offer display name.
publisher_display_name (str) – The marketplace publisher display name.
plan_display_name (str) – The marketplace plan display name.

Keyword Arguments

managed_by_tenant_id (str) – The identifier of the managedBy tenant. Required.
authorizations (list[Authorization]) – The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. Required.
eligible_authorizations (list[EligibleAuthorization]) – The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
offer_display_name (str) – The marketplace offer display name.
publisher_display_name (str) – The marketplace publisher display name.
plan_display_name (str) – The marketplace plan display name.

class azure.mgmt.managedservices.models.MultiFactorAuthProvider(value)[source]¶

Bases: str, enum.Enum

The multi-factor authorization provider to be used for just-in-time access requests.

AZURE = 'Azure'¶

NONE = 'None'¶

class azure.mgmt.managedservices.models.Operation(**kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The object that describes a single Microsoft.ManagedServices operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – The operation name with the format: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.managedservices.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The object that represents the operation.

Variables

provider (str) – The service provider.
resource (str) – The resource on which the operation is performed.
operation (str) – The operation type.
description (str) – The description of the operation.

Keyword Arguments

provider (str) – The service provider.
resource (str) – The resource on which the operation is performed.
operation (str) – The operation type.
description (str) – The description of the operation.

class azure.mgmt.managedservices.models.OperationList(**kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The list of the operations.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: value (list[Operation]) – The list of Microsoft.ManagedServices operations.

class azure.mgmt.managedservices.models.Plan(*, name: str, publisher: str, product: str, version: str, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The details for the Managed Services offer’s plan in Azure Marketplace.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Azure Marketplace plan name. Required.
publisher (str) – Azure Marketplace publisher ID. Required.
product (str) – Azure Marketplace product code. Required.
version (str) – Azure Marketplace plan’s version. Required.

Keyword Arguments

name (str) – Azure Marketplace plan name. Required.
publisher (str) – Azure Marketplace publisher ID. Required.
product (str) – Azure Marketplace product code. Required.
version (str) – Azure Marketplace plan’s version. Required.

class azure.mgmt.managedservices.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

The current provisioning state of the registration definition.

ACCEPTED = 'Accepted'¶

CANCELED = 'Canceled'¶

CREATED = 'Created'¶

CREATING = 'Creating'¶

DELETED = 'Deleted'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

NOT_SPECIFIED = 'NotSpecified'¶

READY = 'Ready'¶

RUNNING = 'Running'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.managedservices.models.RegistrationAssignment(*, properties: Optional[_models.RegistrationAssignmentProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The registration assignment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

properties (RegistrationAssignmentProperties) – The properties of a registration assignment.
id (str) – The fully qualified path of the registration assignment.
type (str) – The type of the Azure resource (Microsoft.ManagedServices/registrationAssignments).
name (str) – The name of the registration assignment.
system_data (SystemData) – The metadata for the registration assignment resource.

Keyword Arguments

properties (RegistrationAssignmentProperties) – The properties of a registration assignment.

class azure.mgmt.managedservices.models.RegistrationAssignmentList(**kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The list of registration assignments.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RegistrationAssignment]) – The list of registration assignments.
next_link (str) – The link to the next page of registration assignments.

class azure.mgmt.managedservices.models.RegistrationAssignmentProperties(*, registration_definition_id: str, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The properties of the registration assignment.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

registration_definition_id (str) – The fully qualified path of the registration definition. Required.
provisioning_state (str or ProvisioningState) – The current provisioning state of the registration assignment. Known values are: “NotSpecified”, “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
registration_definition (RegistrationAssignmentPropertiesRegistrationDefinition) – The registration definition associated with the registration assignment.

Keyword Arguments

registration_definition_id (str) – The fully qualified path of the registration definition. Required.

class azure.mgmt.managedservices.models.RegistrationAssignmentPropertiesRegistrationDefinition(*, properties: Optional[_models.RegistrationAssignmentPropertiesRegistrationDefinitionProperties] = None, plan: Optional[_models.Plan] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The registration definition associated with the registration assignment.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

properties (RegistrationAssignmentPropertiesRegistrationDefinitionProperties) – The properties of the registration definition associated with the registration assignment.
plan (Plan) – The details for the Managed Services offer’s plan in Azure Marketplace.
id (str) – The fully qualified path of the registration definition.
type (str) – The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions).
name (str) – The name of the registration definition.
system_data (SystemData) – The metadata for the registration definition resource.

Keyword Arguments

properties (RegistrationAssignmentPropertiesRegistrationDefinitionProperties) – The properties of the registration definition associated with the registration assignment.
plan (Plan) – The details for the Managed Services offer’s plan in Azure Marketplace.

class azure.mgmt.managedservices.models.RegistrationAssignmentPropertiesRegistrationDefinitionProperties(*, description: Optional[str] = None, authorizations: Optional[List[_models.Authorization]] = None, eligible_authorizations: Optional[List[_models.EligibleAuthorization]] = None, registration_definition_name: Optional[str] = None, provisioning_state: Optional[Union[str, _models.ProvisioningState]] = None, managee_tenant_id: Optional[str] = None, managee_tenant_name: Optional[str] = None, managed_by_tenant_id: Optional[str] = None, managed_by_tenant_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The properties of the registration definition associated with the registration assignment.

Variables

description (str) – The description of the registration definition.
authorizations (list[Authorization]) – The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
eligible_authorizations (list[EligibleAuthorization]) – The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
registration_definition_name (str) – The name of the registration definition.
provisioning_state (str or ProvisioningState) – The current provisioning state of the registration definition. Known values are: “NotSpecified”, “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
managee_tenant_id (str) – The identifier of the managed tenant.
managee_tenant_name (str) – The name of the managed tenant.
managed_by_tenant_id (str) – The identifier of the managedBy tenant.
managed_by_tenant_name (str) – The name of the managedBy tenant.

Keyword Arguments

description (str) – The description of the registration definition.
authorizations (list[Authorization]) – The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
eligible_authorizations (list[EligibleAuthorization]) – The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
registration_definition_name (str) – The name of the registration definition.
provisioning_state (str or ProvisioningState) – The current provisioning state of the registration definition. Known values are: “NotSpecified”, “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
managee_tenant_id (str) – The identifier of the managed tenant.
managee_tenant_name (str) – The name of the managed tenant.
managed_by_tenant_id (str) – The identifier of the managedBy tenant.
managed_by_tenant_name (str) – The name of the managedBy tenant.

class azure.mgmt.managedservices.models.RegistrationDefinition(*, properties: Optional[_models.RegistrationDefinitionProperties] = None, plan: Optional[_models.Plan] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The registration definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

properties (RegistrationDefinitionProperties) – The properties of a registration definition.
plan (Plan) – The details for the Managed Services offer’s plan in Azure Marketplace.
id (str) – The fully qualified path of the registration definition.
type (str) – The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions).
name (str) – The name of the registration definition.
system_data (SystemData) – The metadata for the registration assignment resource.

Keyword Arguments

properties (RegistrationDefinitionProperties) – The properties of a registration definition.
plan (Plan) – The details for the Managed Services offer’s plan in Azure Marketplace.

class azure.mgmt.managedservices.models.RegistrationDefinitionList(**kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The list of registration definitions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[RegistrationDefinition]) – The list of registration definitions.
next_link (str) – The link to the next page of registration definitions.

class azure.mgmt.managedservices.models.RegistrationDefinitionProperties(*, authorizations: List[_models.Authorization], managed_by_tenant_id: str, description: Optional[str] = None, eligible_authorizations: Optional[List[_models.EligibleAuthorization]] = None, registration_definition_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

The properties of a registration definition.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – The description of the registration definition.
authorizations (list[Authorization]) – The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. Required.
eligible_authorizations (list[EligibleAuthorization]) – The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
registration_definition_name (str) – The name of the registration definition.
managed_by_tenant_id (str) – The identifier of the managedBy tenant. Required.
provisioning_state (str or ProvisioningState) – The current provisioning state of the registration definition. Known values are: “NotSpecified”, “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
managee_tenant_id (str) – The identifier of the managed tenant.
managee_tenant_name (str) – The name of the managed tenant.
managed_by_tenant_name (str) – The name of the managedBy tenant.

Keyword Arguments

description (str) – The description of the registration definition.
authorizations (list[Authorization]) – The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. Required.
eligible_authorizations (list[EligibleAuthorization]) – The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant.
registration_definition_name (str) – The name of the registration definition.
managed_by_tenant_id (str) – The identifier of the managedBy tenant. Required.

class azure.mgmt.managedservices.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.managedservices._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).