azure.mgmt.sitemanager.models module

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

Bases: Model

The error detail.

Variables:
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.sitemanager.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.sitemanager.models.ProxyResource(*args: Any, **kwargs: Any)[source]

Bases: Resource

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

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

Bases: ProxyResource

Site as ARM 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.

  • properties (SiteProperties) – The resource-specific properties for this resource.

properties: _models.SiteProperties | None

The resource-specific properties for this resource.

class azure.mgmt.sitemanager.models.SiteAddressProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Site address properties.

Variables:
  • street_address1 (str) – First line of the street address.

  • street_address2 (str) – Second line of the street address.

  • city (str) – City of the address.

  • state_or_province (str) – State or province of the address.

  • country (str) – Country of the address.

  • postal_code (str) – Postal or ZIP code of the address.

city: str | None

City of the address.

country: str | None

Country of the address.

postal_code: str | None

Postal or ZIP code of the address.

state_or_province: str | None

State or province of the address.

street_address1: str | None

First line of the street address.

street_address2: str | None

Second line of the street address.

class azure.mgmt.sitemanager.models.SiteProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

Site properties.

Variables:
  • display_name (str) – displayName of Site resource.

  • description (str) – Description of Site resource.

  • site_address (SiteAddressProperties) – Physical address of the site.

  • labels (dict[str, str]) – Key-value pairs for labeling the site resource.

  • provisioning_state (str or ResourceProvisioningState) – Provisioning state of last operation. Known values are: “Succeeded”, “Failed”, and “Canceled”.

description: str | None

Description of Site resource.

display_name: str | None

displayName of Site resource.

labels: Dict[str, str] | None

Key-value pairs for labeling the site resource.

provisioning_state: str | _models.ResourceProvisioningState | None

“Succeeded”, “Failed”, and “Canceled”.

Type:

Provisioning state of last operation. Known values are

site_address: _models.SiteAddressProperties | None

Physical address of the site.

class azure.mgmt.sitemanager.models.SiteUpdate(*args: Any, **kwargs: Any)[source]

Bases: Model

The type used for update operations of the Site.

Variables:

properties (SiteUpdateProperties) – The updatable properties of the Site.

properties: _models.SiteUpdateProperties | None

The updatable properties of the Site.

class azure.mgmt.sitemanager.models.SiteUpdateProperties(*args: Any, **kwargs: Any)[source]

Bases: Model

The updatable properties of the Site.

Variables:
  • display_name (str) – displayName of Site resource.

  • description (str) – Description of Site resource.

  • site_address (SiteAddressProperties) – Physical address of the site.

  • labels (dict[str, str]) – Key-value pairs for labeling the site resource.

description: str | None

Description of Site resource.

display_name: str | None

displayName of Site resource.

labels: Dict[str, str] | None

Key-value pairs for labeling the site resource.

site_address: _models.SiteAddressProperties | None

Physical address of the site.

class azure.mgmt.sitemanager.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