azure.mgmt.iotcentral.models module¶

class azure.mgmt.iotcentral.models.App(*, location: str, sku: _models.AppSkuInfo, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.SystemAssignedServiceIdentity] = None, display_name: Optional[str] = None, subdomain: Optional[str] = None, template: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral.models._models_py3.Resource

The IoT Central application.

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

id (str) – The ARM resource identifier.
name (str) – The ARM resource name.
type (str) – The resource type.
location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.
sku (AppSkuInfo) – A valid instance SKU. Required.
identity (SystemAssignedServiceIdentity) – The managed identities for the IoT Central application.
application_id (str) – The ID of the application.
display_name (str) – The display name of the application.
subdomain (str) – The subdomain of the application.
template (str) – The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
state (str or AppState) – The current state of the application. Known values are: “created” and “suspended”.

Keyword Arguments

location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.
sku (AppSkuInfo) – A valid instance SKU. Required.
identity (SystemAssignedServiceIdentity) – The managed identities for the IoT Central application.
display_name (str) – The display name of the application.
subdomain (str) – The subdomain of the application.
template (str) – The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.

class azure.mgmt.iotcentral.models.AppAvailabilityInfo(**kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

The properties indicating whether a given IoT Central application name or subdomain is available.

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

Variables

name_available (bool) – The value which indicates whether the provided name is available.
reason (str) – The reason for unavailability.
message (str) – The detailed reason message.

class azure.mgmt.iotcentral.models.AppListResult(*, next_link: Optional[str] = None, value: Optional[List[_models.App]] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

A list of IoT Central Applications with a next link.

Variables

next_link (str) – The link used to get the next page of IoT Central Applications.
value (list[App]) – A list of IoT Central Applications.

Keyword Arguments

next_link (str) – The link used to get the next page of IoT Central Applications.
value (list[App]) – A list of IoT Central Applications.

class azure.mgmt.iotcentral.models.AppPatch(*, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.AppSkuInfo] = None, identity: Optional[_models.SystemAssignedServiceIdentity] = None, display_name: Optional[str] = None, subdomain: Optional[str] = None, template: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

The description of the IoT Central application.

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

Variables

tags (dict[str, str]) – Instance tags.
sku (AppSkuInfo) – A valid instance SKU.
identity (SystemAssignedServiceIdentity) – The managed identities for the IoT Central application.
application_id (str) – The ID of the application.
display_name (str) – The display name of the application.
subdomain (str) – The subdomain of the application.
template (str) – The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.
state (str or AppState) – The current state of the application. Known values are: “created” and “suspended”.

Keyword Arguments

tags (dict[str, str]) – Instance tags.
sku (AppSkuInfo) – A valid instance SKU.
identity (SystemAssignedServiceIdentity) – The managed identities for the IoT Central application.
display_name (str) – The display name of the application.
subdomain (str) – The subdomain of the application.
template (str) – The ID of the application template, which is a blueprint that defines the characteristics and behaviors of an application. Optional; if not specified, defaults to a blank blueprint and allows the application to be defined from scratch.

class azure.mgmt.iotcentral.models.AppSku(value)[source]¶

Bases: str, enum.Enum

The name of the SKU.

ST0 = 'ST0'¶

ST1 = 'ST1'¶

ST2 = 'ST2'¶

class azure.mgmt.iotcentral.models.AppSkuInfo(*, name: Union[str, _models.AppSku], **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

Information about the SKU of the IoT Central application.

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

Variables: name (str or AppSku) – The name of the SKU. Required. Known values are: “ST0”, “ST1”, and “ST2”.
Keyword Arguments: name (str or AppSku) – The name of the SKU. Required. Known values are: “ST0”, “ST1”, and “ST2”.

class azure.mgmt.iotcentral.models.AppState(value)[source]¶

Bases: str, enum.Enum

The current state of the application.

CREATED = 'created'¶

SUSPENDED = 'suspended'¶

class azure.mgmt.iotcentral.models.AppTemplate(**kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

IoT Central Application Template.

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

Variables

manifest_id (str) – The ID of the template.
manifest_version (str) – The version of the template.
name (str) – The name of the template.
title (str) – The title of the template.
order (float) – The order of the template in the templates list.
description (str) – The description of the template.
industry (str) – The industry of the template.
locations (list[AppTemplateLocations]) – A list of locations that support the template.

class azure.mgmt.iotcentral.models.AppTemplateLocations(**kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

IoT Central Application Template Locations.

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

Variables

id (str) – The ID of the location.
display_name (str) – The display name of the location.

class azure.mgmt.iotcentral.models.AppTemplatesResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

A list of IoT Central Application Templates with a next link.

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

Variables

next_link (str) – The link used to get the next page of IoT Central application templates.
value (list[AppTemplate]) – A list of IoT Central Application Templates.

Keyword Arguments

next_link (str) – The link used to get the next page of IoT Central application templates.

class azure.mgmt.iotcentral.models.CloudErrorBody(*, details: Optional[List[_models.CloudErrorBody]] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

Details of error response.

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

Variables

code (str) – The error code.
message (str) – The error message.
target (str) – The target of the particular error.
details (list[CloudErrorBody]) – A list of additional details about the error.

Keyword Arguments

details (list[CloudErrorBody]) – A list of additional details about the error.

class azure.mgmt.iotcentral.models.Operation(*, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

IoT Central REST API operation.

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

Variables

name (str) – Operation name: {provider}/{resource}/{read | write | action | delete}.
display (OperationDisplay) – The object that represents the operation.
origin (str) – The intended executor of the operation.
properties (JSON) – Additional descriptions for the operation.

Keyword Arguments

display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.iotcentral.models.OperationDisplay(**kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

The object that represents the operation.

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

Variables

provider (str) – Service provider: Microsoft IoT Central.
resource (str) – Resource Type: IoT Central.
operation (str) – Name of the operation.
description (str) – Friendly description for the operation,.

class azure.mgmt.iotcentral.models.OperationInputs(*, name: str, type: str = 'IoTApps', **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

Input values.

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

Variables

name (str) – The name of the IoT Central application instance to check. Required.
type (str) – The type of the IoT Central resource to query.

Keyword Arguments

name (str) – The name of the IoT Central application instance to check. Required.
type (str) – The type of the IoT Central resource to query.

class azure.mgmt.iotcentral.models.OperationListResult(*, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

A list of IoT Central operations. It contains a list of operations and a URL link to get the next set of results.

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

Variables

next_link (str) – The link used to get the next page of IoT Central description objects.
value (list[Operation]) – A list of operations supported by the Microsoft.IoTCentral resource provider.

Keyword Arguments

next_link (str) – The link used to get the next page of IoT Central description objects.

class azure.mgmt.iotcentral.models.Resource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

The common properties of an ARM resource.

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

id (str) – The ARM resource identifier.
name (str) – The ARM resource name.
type (str) – The resource type.
location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.

Keyword Arguments

location (str) – The resource location. Required.
tags (dict[str, str]) – The resource tags.

class azure.mgmt.iotcentral.models.SystemAssignedServiceIdentity(*, type: Union[str, _models.SystemAssignedServiceIdentityType], **kwargs)[source]¶

Bases: azure.mgmt.iotcentral._serialization.Model

Managed service identity (either system assigned, or none).

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

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 SystemAssignedServiceIdentityType) – Type of managed service identity (either system assigned, or none). Required. Known values are: “None” and “SystemAssigned”.

Keyword Arguments

type (str or SystemAssignedServiceIdentityType) – Type of managed service identity (either system assigned, or none). Required. Known values are: “None” and “SystemAssigned”.

class azure.mgmt.iotcentral.models.SystemAssignedServiceIdentityType(value)[source]¶

Bases: str, enum.Enum

Type of managed service identity (either system assigned, or none).

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶