azure.mgmt.resource.templatespecs.v2022_02_01.models module

class azure.mgmt.resource.templatespecs.v2022_02_01.models.AzureResourceBase(**kwargs: Any)[source]

Bases: Model

Common properties for all Azure resources.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.CreatedByType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

The type of identity that created the resource.

APPLICATION = 'Application'
KEY = 'Key'
MANAGED_IDENTITY = 'ManagedIdentity'
USER = 'User'
class azure.mgmt.resource.templatespecs.v2022_02_01.models.ErrorAdditionalInfo(**kwargs: Any)[source]

Bases: Model

The resource management error additional info.

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

Variables:

  • type (str) – The additional info type.

  • info (JSON) – The additional info.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.ErrorResponse(**kwargs: Any)[source]

Bases: Model

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

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

Variables:
class azure.mgmt.resource.templatespecs.v2022_02_01.models.LinkedTemplateArtifact(*, path: str, template: MutableMapping[str, Any], **kwargs: Any)[source]

Bases: Model

Represents a Template Spec artifact containing an embedded Azure Resource Manager template for use as a linked template.

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

Variables:

  • path (str) – A filesystem safe relative path of the artifact. Required.

  • template (JSON) – The Azure Resource Manager template. Required.

Keyword Arguments:

  • path (str) – A filesystem safe relative path of the artifact. Required.

  • template (JSON) – The Azure Resource Manager template. Required.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.SystemData(*, created_by: str | None = None, created_by_type: str | _models.CreatedByType | None = None, created_at: datetime | None = None, last_modified_by: str | None = None, last_modified_by_type: str | _models.CreatedByType | None = None, last_modified_at: datetime | None = None, **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).

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

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpec(*, location: str, tags: Dict[str, str] | None = None, description: str | None = None, display_name: str | None = None, metadata: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Template Spec object.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • location (str) – The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Required.

  • tags (dict[str, str]) – Resource tags.

  • description (str) – Template Spec description.

  • display_name (str) – Template Spec display name.

  • metadata (JSON) – The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.

  • versions (dict[str, TemplateSpecVersionInfo]) – High-level information about the versions within this Template Spec. The keys are the version names. Only populated if the $expand query parameter is set to ‘versions’.

Keyword Arguments:

  • location (str) – The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations. Required.

  • tags (dict[str, str]) – Resource tags.

  • description (str) – Template Spec description.

  • display_name (str) – Template Spec display name.

  • metadata (JSON) – The Template Spec metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecExpandKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Bases: str, Enum

TemplateSpecExpandKind.

VERSIONS = 'versions'

Includes version information with the Template Spec.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecUpdateModel(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Template Spec properties to be updated (only tags are currently supported).

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecVersion(*, location: str, tags: Dict[str, str] | None = None, description: str | None = None, linked_templates: List[_models.LinkedTemplateArtifact] | None = None, metadata: MutableMapping[str, Any] | None = None, main_template: MutableMapping[str, Any] | None = None, ui_form_definition: MutableMapping[str, Any] | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Template Spec Version object.

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • location (str) – The location of the Template Spec Version. It must match the location of the parent Template Spec. Required.

  • tags (dict[str, str]) – Resource tags.

  • description (str) – Template Spec version description.

  • linked_templates (list[LinkedTemplateArtifact]) – An array of linked template artifacts.

  • metadata (JSON) – The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.

  • main_template (JSON) – The main Azure Resource Manager template content.

  • ui_form_definition (JSON) – The Azure Resource Manager template UI definition content.

Keyword Arguments:

  • location (str) – The location of the Template Spec Version. It must match the location of the parent Template Spec. Required.

  • tags (dict[str, str]) – Resource tags.

  • description (str) – Template Spec version description.

  • linked_templates (list[LinkedTemplateArtifact]) – An array of linked template artifacts.

  • metadata (JSON) – The version metadata. Metadata is an open-ended object and is typically a collection of key-value pairs.

  • main_template (JSON) – The main Azure Resource Manager template content.

  • ui_form_definition (JSON) – The Azure Resource Manager template UI definition content.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecVersionInfo(**kwargs: Any)[source]

Bases: Model

High-level information about a Template Spec version.

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

Variables:

  • description (str) – Template Spec version description.

  • time_created (datetime) – The timestamp of when the version was created.

  • time_modified (datetime) – The timestamp of when the version was last modified.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecVersionUpdateModel(*, tags: Dict[str, str] | None = None, **kwargs: Any)[source]

Bases: AzureResourceBase

Template Spec Version properties to be updated (only tags are currently supported).

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

Variables:

  • id (str) – String Id used to locate any resource on Azure.

  • name (str) – Name of this resource.

  • type (str) – Type of this resource.

  • system_data (SystemData) – Azure Resource Manager metadata containing createdBy and modifiedBy information.

  • tags (dict[str, str]) – Resource tags.

Keyword Arguments:

tags (dict[str, str]) – Resource tags.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecVersionsListResult(*, value: List[_models.TemplateSpecVersion] | None = None, **kwargs: Any)[source]

Bases: Model

List of Template Specs versions.

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

Variables:

  • value (list[TemplateSpecVersion]) – An array of Template Spec versions.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[TemplateSpecVersion]) – An array of Template Spec versions.

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecsError(*, error: _models.ErrorResponse | None = None, **kwargs: Any)[source]

Bases: Model

Template Specs error response.

Variables:

error (ErrorResponse) – Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Keyword Arguments:

error (ErrorResponse) – Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

class azure.mgmt.resource.templatespecs.v2022_02_01.models.TemplateSpecsListResult(*, value: List[_models.TemplateSpec] | None = None, **kwargs: Any)[source]

Bases: Model

List of Template Specs.

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

Variables:

  • value (list[TemplateSpec]) – An array of Template Specs.

  • next_link (str) – The URL to use for getting the next set of results.

Keyword Arguments:

value (list[TemplateSpec]) – An array of Template Specs.