azure.mgmt.portalservicescopilot.models module

class azure.mgmt.portalservicescopilot.models.ActionType(*values)[source]

Bases: str, Enum

Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs.

INTERNAL = 'Internal': Actions are for internal-only APIs.

class azure.mgmt.portalservicescopilot.models.CopilotSettingsProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

The Copilot Settings properties.

Variables:

access_control_enabled (bool) – Boolean indicating if role-based access control is enabled for copilot in this tenant. Required.
provisioning_state (str or ResourceProvisioningState) – The status of the last provisioning operation performed on the resource. Known values are: “Succeeded”, “Failed”, and “Canceled”.

access_control_enabled: bool: Boolean indicating if role-based access control is enabled for copilot in this tenant. Required.

provisioning_state: str | _models.ResourceProvisioningState | None: The status of the last provisioning operation performed on the resource. Known values are: “Succeeded”, “Failed”, and “Canceled”.

class azure.mgmt.portalservicescopilot.models.CopilotSettingsResource(*args: Any, **kwargs: Any)[source]

Bases: ProxyResource

The copilot settings tenant resource definition.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.
properties (CopilotSettingsProperties) – The resource-specific properties for this resource.

properties: _models.CopilotSettingsProperties | None: The resource-specific properties for this resource.

class azure.mgmt.portalservicescopilot.models.CopilotSettingsResourceUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The type used for update operations of the CopilotSettingsResource.

Variables:: properties (CopilotSettingsResourceUpdateProperties) – The resource-specific properties for this resource.

properties: _models.CopilotSettingsResourceUpdateProperties | None: The resource-specific properties for this resource.

class azure.mgmt.portalservicescopilot.models.CopilotSettingsResourceUpdateProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

The updatable properties of the CopilotSettingsResource.

Variables:: access_control_enabled (bool) – Boolean indicating if role-based access control is enabled for copilot in this tenant.

access_control_enabled: bool | None: Boolean indicating if role-based access control is enabled for copilot in this tenant.

class azure.mgmt.portalservicescopilot.models.CreatedByType(*values)[source]

Bases: str, Enum

The kind of entity that created the resource.

APPLICATION = 'Application': The entity was created by an application.

KEY = 'Key': The entity was created by a key.

MANAGED_IDENTITY = 'ManagedIdentity': The entity was created by a managed identity.

USER = 'User': The entity was created by a user.

class azure.mgmt.portalservicescopilot.models.ErrorAdditionalInfo(*args: Any, **kwargs: Any)[source]

Bases: Model

The resource management error additional info.

Variables:

type (str) – The additional info type.
info (any) – The additional info.

info: Any | None: The additional info.

type: str | None: The additional info type.

class azure.mgmt.portalservicescopilot.models.ErrorDetail(*args: Any, **kwargs: Any)[source]

Bases: Model

The error detail.

Variables:

code (str) – The error code.
message (str) – The error message.
target (str) – The error target.
details (list[ErrorDetail]) – The error details.
additional_info (list[ErrorAdditionalInfo]) – The error additional info.

additional_info: List[_models.ErrorAdditionalInfo] | None: The error additional info.

code: str | None: The error code.

details: List[_models.ErrorDetail] | None: The error details.

message: str | None: The error message.

target: str | None: The error target.

class azure.mgmt.portalservicescopilot.models.ErrorResponse(*args: Any, **kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations.

Variables:: error (ErrorDetail) – The error object.

error: _models.ErrorDetail | None: The error object.

class azure.mgmt.portalservicescopilot.models.Operation(*args: Any, **kwargs: Any)[source]

Bases: Model

Details of a REST API operation, returned from the Resource Provider Operations API.

Variables:

name (str) – The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.
is_data_action (bool) – Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.
display (OperationDisplay) – Localized display information for this particular operation.
origin (str or Origin) – The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.
action_type (str or ActionType) – Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

action_type: str | _models.ActionType | None: Extensible enum. Indicates the action type. “Internal” refers to actions that are for internal only APIs. “Internal”

display: _models.OperationDisplay | None: Localized display information for this particular operation.

is_data_action: bool | None: Whether the operation applies to data-plane. This is “true” for data-plane operations and “false” for Azure Resource Manager/control-plane operations.

name: str | None: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: “Microsoft.Compute/virtualMachines/write”, “Microsoft.Compute/virtualMachines/capture/action”.

origin: str | _models.Origin | None: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”. Known values are: “user”, “system”, and “user,system”.

class azure.mgmt.portalservicescopilot.models.OperationDisplay(*args: Any, **kwargs: Any)[source]

Bases: Model

Localized display information for and operation.

Variables:

provider (str) – The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.
resource (str) – The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.
operation (str) – The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.
description (str) – The short, localized friendly description of the operation; suitable for tool tips and detailed views.

description: str | None: The short, localized friendly description of the operation; suitable for tool tips and detailed views.

operation: str | None: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. “Create or Update Virtual Machine”, “Restart Virtual Machine”.

provider: str | None: The localized friendly form of the resource provider name, e.g. “Microsoft Monitoring Insights” or “Microsoft Compute”.

resource: str | None: The localized friendly name of the resource type related to this operation. E.g. “Virtual Machines” or “Job Schedule Collections”.

class azure.mgmt.portalservicescopilot.models.Origin(*values)[source]

Bases: str, Enum

The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is “user,system”.

SYSTEM = 'system': Indicates the operation is initiated by a system.

USER = 'user': Indicates the operation is initiated by a user.

USER_SYSTEM = 'user,system': Indicates the operation is initiated by a user or system.

class azure.mgmt.portalservicescopilot.models.ProxyResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.portalservicescopilot.models.Resource(*args: Any, **kwargs: Any)[source]

Bases: Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables:

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

id: str | None: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name: str | None: The name of the resource.

system_data: _models.SystemData | None: Azure Resource Manager metadata containing createdBy and modifiedBy information.

type: str | None: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.portalservicescopilot.models.ResourceProvisioningState(*values)[source]

Bases: str, Enum

The provisioning state of a resource type.

CANCELED = 'Canceled': Resource creation was canceled.

FAILED = 'Failed': Resource creation failed.

SUCCEEDED = 'Succeeded': Resource has been created.

class azure.mgmt.portalservicescopilot.models.SystemData(*args: Any, **kwargs: Any)[source]

Bases: 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).

created_at: datetime | None: The timestamp of resource creation (UTC).

created_by: str | None: The identity that created the resource.

created_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:: The type of identity that created the resource. Known values are

last_modified_at: datetime | None: The timestamp of resource last modification (UTC).

last_modified_by: str | None: The identity that last modified the resource.

last_modified_by_type: str | _models.CreatedByType | None

“User”, “Application”, “ManagedIdentity”, and “Key”.

Type:: The type of identity that last modified the resource. Known values are