azure.mgmt.planetarycomputer.models module

class azure.mgmt.planetarycomputer.models.AutoGeneratedDomainNameLabelScope(*values)[source]

Bases: str, Enum

The scope at which the auto-generated domain name label is generated and at which the resource name can be reused.

NO_REUSE = 'NoReuse': The domain name label is randomly generated. The resource name cannot be reused within the same region.

RESOURCE_GROUP_REUSE = 'ResourceGroupReuse': The domain name label is deterministically generated using the resource name, tenant id, subscription id, and resource group name. The resource name cannot be reused within the same resource group.

SUBSCRIPTION_REUSE = 'SubscriptionReuse': The domain name label is deterministically generated using the resource name, tenant id, and subscription id. The resource name cannot be reused within the same region and subscription.

TENANT_REUSE = 'TenantReuse': The domain name label is deterministically generated using the resource name and tenant id. The resource name cannot be reused within the same region and tenant.

class azure.mgmt.planetarycomputer.models.CatalogTier(*values)[source]

Bases: str, Enum

The Microsoft Planetary Computer Pro GeoCatalog tier.

BASIC = 'Basic': The basic tier that utilizes shared resources across catalog instances

class azure.mgmt.planetarycomputer.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.planetarycomputer.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.planetarycomputer.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.planetarycomputer.models.ErrorResponse(*args: Any, **kwargs: Any)[source]

Bases: Model

Error response.

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

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

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

Bases: TrackedResource

A Microsoft Planetary Computer Pro GeoCatalog resource.

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.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.
properties (GeoCatalogProperties) – The resource-specific properties for this resource.
identity (ManagedServiceIdentity) – The managed service identities assigned to this resource.

identity: _models.ManagedServiceIdentity | None: The managed service identities assigned to this resource.

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

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

Bases: Model

The details of the Microsoft Planetary Computer Pro GeoCatalog.

Variables:

tier (str or CatalogTier) – Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic. “Basic”
catalog_uri (str) – The URI of the catalog management UI.
provisioning_state (str or ProvisioningState) – The status of the last operation. Known values are: “Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.
auto_generated_domain_name_label_scope (str or AutoGeneratedDomainNameLabelScope) – The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse. Known values are: “NoReuse”, “TenantReuse”, “SubscriptionReuse”, and “ResourceGroupReuse”.

auto_generated_domain_name_label_scope: str | _models.AutoGeneratedDomainNameLabelScope | None: The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse. Known values are: “NoReuse”, “TenantReuse”, “SubscriptionReuse”, and “ResourceGroupReuse”.

catalog_uri: str | None: The URI of the catalog management UI.

provisioning_state: str | _models.ProvisioningState | None

“Succeeded”, “Failed”, “Canceled”, “Provisioning”, “Updating”, “Deleting”, and “Accepted”.

Type:: The status of the last operation. Known values are

tier: str | _models.CatalogTier | None: Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic. “Basic”

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

Bases: Model

The properties of a GeoCatalog that can be updated.

Variables:

tags (dict[str, str]) – Resource tags.
identity (ManagedServiceIdentityUpdate) – The managed service identity properties to update.

identity: _models.ManagedServiceIdentityUpdate | None: The managed service identity properties to update.

tags: Dict[str, str] | None: Resource tags.

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

Bases: Model

Managed service identity (system assigned and/or user assigned identities).

Variables:

principal_id (str) – The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id (str) – The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Required. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

principal_id: str | None: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

tenant_id: str | None: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

type: str | _models.ManagedServiceIdentityType

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:: The type of managed identity assigned to this resource. Required. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None: The identities assigned to this resource by the user.

class azure.mgmt.planetarycomputer.models.ManagedServiceIdentityType(*values)[source]

Bases: str, Enum

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

NONE = 'None': No managed identity.

SYSTEM_ASSIGNED = 'SystemAssigned': System assigned managed identity.

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned,UserAssigned': System and user assigned managed identity.

USER_ASSIGNED = 'UserAssigned': User assigned managed identity.

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

Bases: Model

The template for adding optional properties.

Variables:

type (str or ManagedServiceIdentityType) – The type of managed identity assigned to this resource. Known values are: “None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.
user_assigned_identities (dict[str, UserAssignedIdentity]) – The identities assigned to this resource by the user.

type: str | _models.ManagedServiceIdentityType | None

“None”, “SystemAssigned”, “UserAssigned”, and “SystemAssigned,UserAssigned”.

Type:: The type of managed identity assigned to this resource. Known values are

user_assigned_identities: Dict[str, _models.UserAssignedIdentity] | None: The identities assigned to this resource by the user.

class azure.mgmt.planetarycomputer.models.ProvisioningState(*values)[source]

Bases: str, Enum

The status of the current operation.

ACCEPTED = 'Accepted': The catalog request has been accepted.

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

DELETING = 'Deleting': The catalog is being deleted.

FAILED = 'Failed': Resource creation failed.

PROVISIONING = 'Provisioning': The catalog is being provisioned.

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

UPDATING = 'Updating': The catalog is being updated.

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

Bases: Model

Resource.

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

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

Bases: Resource

Tracked Resource.

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.
tags (dict[str, str]) – Resource tags.
location (str) – The geo-location where the resource lives. Required.

location: str: The geo-location where the resource lives. Required.

tags: Dict[str, str] | None: Resource tags.

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

Bases: Model

User assigned identity properties.

Variables:

principal_id (str) – The principal ID of the assigned identity.
client_id (str) – The client ID of the assigned identity.

client_id: str | None: The client ID of the assigned identity.

principal_id: str | None: The principal ID of the assigned identity.