1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
|
# coding=utf-8
# pylint: disable=too-many-lines
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
from typing import Dict, List, Optional, TYPE_CHECKING, Union
from .. import _serialization
if TYPE_CHECKING:
# pylint: disable=unused-import,ungrouped-imports
from .. import models as _models
class Resource(_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.
:ivar id: The ARM resource identifier.
:vartype id: str
:ivar name: The ARM resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar location: The resource location. Required.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$"},
"type": {"readonly": True},
"location": {"required": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
}
def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kwargs):
"""
:keyword location: The resource location. Required.
:paramtype location: str
:keyword tags: The resource tags.
:paramtype tags: dict[str, str]
"""
super().__init__(**kwargs)
self.id = None
self.name = None
self.type = None
self.location = location
self.tags = tags
class App(Resource): # pylint: disable=too-many-instance-attributes
"""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.
:ivar id: The ARM resource identifier.
:vartype id: str
:ivar name: The ARM resource name.
:vartype name: str
:ivar type: The resource type.
:vartype type: str
:ivar location: The resource location. Required.
:vartype location: str
:ivar tags: The resource tags.
:vartype tags: dict[str, str]
:ivar sku: A valid instance SKU. Required.
:vartype sku: ~azure.mgmt.iotcentral.models.AppSkuInfo
:ivar identity: The managed identities for the IoT Central application.
:vartype identity: ~azure.mgmt.iotcentral.models.SystemAssignedServiceIdentity
:ivar application_id: The ID of the application.
:vartype application_id: str
:ivar display_name: The display name of the application.
:vartype display_name: str
:ivar subdomain: The subdomain of the application.
:vartype subdomain: str
:ivar template: 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.
:vartype template: str
:ivar state: The current state of the application. Known values are: "created" and "suspended".
:vartype state: str or ~azure.mgmt.iotcentral.models.AppState
"""
_validation = {
"id": {"readonly": True},
"name": {"readonly": True, "pattern": r"^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$"},
"type": {"readonly": True},
"location": {"required": True},
"sku": {"required": True},
"application_id": {"readonly": True},
"state": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
"location": {"key": "location", "type": "str"},
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "AppSkuInfo"},
"identity": {"key": "identity", "type": "SystemAssignedServiceIdentity"},
"application_id": {"key": "properties.applicationId", "type": "str"},
"display_name": {"key": "properties.displayName", "type": "str"},
"subdomain": {"key": "properties.subdomain", "type": "str"},
"template": {"key": "properties.template", "type": "str"},
"state": {"key": "properties.state", "type": "str"},
}
def __init__(
self,
*,
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
):
"""
:keyword location: The resource location. Required.
:paramtype location: str
:keyword tags: The resource tags.
:paramtype tags: dict[str, str]
:keyword sku: A valid instance SKU. Required.
:paramtype sku: ~azure.mgmt.iotcentral.models.AppSkuInfo
:keyword identity: The managed identities for the IoT Central application.
:paramtype identity: ~azure.mgmt.iotcentral.models.SystemAssignedServiceIdentity
:keyword display_name: The display name of the application.
:paramtype display_name: str
:keyword subdomain: The subdomain of the application.
:paramtype subdomain: str
:keyword template: 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.
:paramtype template: str
"""
super().__init__(location=location, tags=tags, **kwargs)
self.sku = sku
self.identity = identity
self.application_id = None
self.display_name = display_name
self.subdomain = subdomain
self.template = template
self.state = None
class AppAvailabilityInfo(_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.
:ivar name_available: The value which indicates whether the provided name is available.
:vartype name_available: bool
:ivar reason: The reason for unavailability.
:vartype reason: str
:ivar message: The detailed reason message.
:vartype message: str
"""
_validation = {
"name_available": {"readonly": True},
"reason": {"readonly": True},
"message": {"readonly": True},
}
_attribute_map = {
"name_available": {"key": "nameAvailable", "type": "bool"},
"reason": {"key": "reason", "type": "str"},
"message": {"key": "message", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.name_available = None
self.reason = None
self.message = None
class AppListResult(_serialization.Model):
"""A list of IoT Central Applications with a next link.
:ivar next_link: The link used to get the next page of IoT Central Applications.
:vartype next_link: str
:ivar value: A list of IoT Central Applications.
:vartype value: list[~azure.mgmt.iotcentral.models.App]
"""
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[App]"},
}
def __init__(self, *, next_link: Optional[str] = None, value: Optional[List["_models.App"]] = None, **kwargs):
"""
:keyword next_link: The link used to get the next page of IoT Central Applications.
:paramtype next_link: str
:keyword value: A list of IoT Central Applications.
:paramtype value: list[~azure.mgmt.iotcentral.models.App]
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = value
class AppPatch(_serialization.Model):
"""The description of the IoT Central application.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar tags: Instance tags.
:vartype tags: dict[str, str]
:ivar sku: A valid instance SKU.
:vartype sku: ~azure.mgmt.iotcentral.models.AppSkuInfo
:ivar identity: The managed identities for the IoT Central application.
:vartype identity: ~azure.mgmt.iotcentral.models.SystemAssignedServiceIdentity
:ivar application_id: The ID of the application.
:vartype application_id: str
:ivar display_name: The display name of the application.
:vartype display_name: str
:ivar subdomain: The subdomain of the application.
:vartype subdomain: str
:ivar template: 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.
:vartype template: str
:ivar state: The current state of the application. Known values are: "created" and "suspended".
:vartype state: str or ~azure.mgmt.iotcentral.models.AppState
"""
_validation = {
"application_id": {"readonly": True},
"state": {"readonly": True},
}
_attribute_map = {
"tags": {"key": "tags", "type": "{str}"},
"sku": {"key": "sku", "type": "AppSkuInfo"},
"identity": {"key": "identity", "type": "SystemAssignedServiceIdentity"},
"application_id": {"key": "properties.applicationId", "type": "str"},
"display_name": {"key": "properties.displayName", "type": "str"},
"subdomain": {"key": "properties.subdomain", "type": "str"},
"template": {"key": "properties.template", "type": "str"},
"state": {"key": "properties.state", "type": "str"},
}
def __init__(
self,
*,
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
):
"""
:keyword tags: Instance tags.
:paramtype tags: dict[str, str]
:keyword sku: A valid instance SKU.
:paramtype sku: ~azure.mgmt.iotcentral.models.AppSkuInfo
:keyword identity: The managed identities for the IoT Central application.
:paramtype identity: ~azure.mgmt.iotcentral.models.SystemAssignedServiceIdentity
:keyword display_name: The display name of the application.
:paramtype display_name: str
:keyword subdomain: The subdomain of the application.
:paramtype subdomain: str
:keyword template: 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.
:paramtype template: str
"""
super().__init__(**kwargs)
self.tags = tags
self.sku = sku
self.identity = identity
self.application_id = None
self.display_name = display_name
self.subdomain = subdomain
self.template = template
self.state = None
class AppSkuInfo(_serialization.Model):
"""Information about the SKU of the IoT Central application.
All required parameters must be populated in order to send to Azure.
:ivar name: The name of the SKU. Required. Known values are: "ST0", "ST1", and "ST2".
:vartype name: str or ~azure.mgmt.iotcentral.models.AppSku
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
}
def __init__(self, *, name: Union[str, "_models.AppSku"], **kwargs):
"""
:keyword name: The name of the SKU. Required. Known values are: "ST0", "ST1", and "ST2".
:paramtype name: str or ~azure.mgmt.iotcentral.models.AppSku
"""
super().__init__(**kwargs)
self.name = name
class AppTemplate(_serialization.Model):
"""IoT Central Application Template.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar manifest_id: The ID of the template.
:vartype manifest_id: str
:ivar manifest_version: The version of the template.
:vartype manifest_version: str
:ivar name: The name of the template.
:vartype name: str
:ivar title: The title of the template.
:vartype title: str
:ivar order: The order of the template in the templates list.
:vartype order: float
:ivar description: The description of the template.
:vartype description: str
:ivar industry: The industry of the template.
:vartype industry: str
:ivar locations: A list of locations that support the template.
:vartype locations: list[~azure.mgmt.iotcentral.models.AppTemplateLocations]
"""
_validation = {
"manifest_id": {"readonly": True},
"manifest_version": {"readonly": True},
"name": {"readonly": True},
"title": {"readonly": True},
"order": {"readonly": True},
"description": {"readonly": True},
"industry": {"readonly": True},
"locations": {"readonly": True},
}
_attribute_map = {
"manifest_id": {"key": "manifestId", "type": "str"},
"manifest_version": {"key": "manifestVersion", "type": "str"},
"name": {"key": "name", "type": "str"},
"title": {"key": "title", "type": "str"},
"order": {"key": "order", "type": "float"},
"description": {"key": "description", "type": "str"},
"industry": {"key": "industry", "type": "str"},
"locations": {"key": "locations", "type": "[AppTemplateLocations]"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.manifest_id = None
self.manifest_version = None
self.name = None
self.title = None
self.order = None
self.description = None
self.industry = None
self.locations = None
class AppTemplateLocations(_serialization.Model):
"""IoT Central Application Template Locations.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar id: The ID of the location.
:vartype id: str
:ivar display_name: The display name of the location.
:vartype display_name: str
"""
_validation = {
"id": {"readonly": True},
"display_name": {"readonly": True},
}
_attribute_map = {
"id": {"key": "id", "type": "str"},
"display_name": {"key": "displayName", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.id = None
self.display_name = None
class AppTemplatesResult(_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.
:ivar next_link: The link used to get the next page of IoT Central application templates.
:vartype next_link: str
:ivar value: A list of IoT Central Application Templates.
:vartype value: list[~azure.mgmt.iotcentral.models.AppTemplate]
"""
_validation = {
"value": {"readonly": True},
}
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[AppTemplate]"},
}
def __init__(self, *, next_link: Optional[str] = None, **kwargs):
"""
:keyword next_link: The link used to get the next page of IoT Central application templates.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = None
class CloudErrorBody(_serialization.Model):
"""Details of error response.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar code: The error code.
:vartype code: str
:ivar message: The error message.
:vartype message: str
:ivar target: The target of the particular error.
:vartype target: str
:ivar details: A list of additional details about the error.
:vartype details: list[~azure.mgmt.iotcentral.models.CloudErrorBody]
"""
_validation = {
"code": {"readonly": True},
"message": {"readonly": True},
"target": {"readonly": True},
}
_attribute_map = {
"code": {"key": "code", "type": "str"},
"message": {"key": "message", "type": "str"},
"target": {"key": "target", "type": "str"},
"details": {"key": "details", "type": "[CloudErrorBody]"},
}
def __init__(self, *, details: Optional[List["_models.CloudErrorBody"]] = None, **kwargs):
"""
:keyword details: A list of additional details about the error.
:paramtype details: list[~azure.mgmt.iotcentral.models.CloudErrorBody]
"""
super().__init__(**kwargs)
self.code = None
self.message = None
self.target = None
self.details = details
class Operation(_serialization.Model):
"""IoT Central REST API operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar name: Operation name: {provider}/{resource}/{read | write | action | delete}.
:vartype name: str
:ivar display: The object that represents the operation.
:vartype display: ~azure.mgmt.iotcentral.models.OperationDisplay
:ivar origin: The intended executor of the operation.
:vartype origin: str
:ivar properties: Additional descriptions for the operation.
:vartype properties: JSON
"""
_validation = {
"name": {"readonly": True},
"origin": {"readonly": True},
"properties": {"readonly": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"display": {"key": "display", "type": "OperationDisplay"},
"origin": {"key": "origin", "type": "str"},
"properties": {"key": "properties", "type": "object"},
}
def __init__(self, *, display: Optional["_models.OperationDisplay"] = None, **kwargs):
"""
:keyword display: The object that represents the operation.
:paramtype display: ~azure.mgmt.iotcentral.models.OperationDisplay
"""
super().__init__(**kwargs)
self.name = None
self.display = display
self.origin = None
self.properties = None
class OperationDisplay(_serialization.Model):
"""The object that represents the operation.
Variables are only populated by the server, and will be ignored when sending a request.
:ivar provider: Service provider: Microsoft IoT Central.
:vartype provider: str
:ivar resource: Resource Type: IoT Central.
:vartype resource: str
:ivar operation: Name of the operation.
:vartype operation: str
:ivar description: Friendly description for the operation,.
:vartype description: str
"""
_validation = {
"provider": {"readonly": True},
"resource": {"readonly": True},
"operation": {"readonly": True},
"description": {"readonly": True},
}
_attribute_map = {
"provider": {"key": "provider", "type": "str"},
"resource": {"key": "resource", "type": "str"},
"operation": {"key": "operation", "type": "str"},
"description": {"key": "description", "type": "str"},
}
def __init__(self, **kwargs):
""" """
super().__init__(**kwargs)
self.provider = None
self.resource = None
self.operation = None
self.description = None
class OperationInputs(_serialization.Model):
"""Input values.
All required parameters must be populated in order to send to Azure.
:ivar name: The name of the IoT Central application instance to check. Required.
:vartype name: str
:ivar type: The type of the IoT Central resource to query.
:vartype type: str
"""
_validation = {
"name": {"required": True},
}
_attribute_map = {
"name": {"key": "name", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, *, name: str, type: str = "IoTApps", **kwargs):
"""
:keyword name: The name of the IoT Central application instance to check. Required.
:paramtype name: str
:keyword type: The type of the IoT Central resource to query.
:paramtype type: str
"""
super().__init__(**kwargs)
self.name = name
self.type = type
class OperationListResult(_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.
:ivar next_link: The link used to get the next page of IoT Central description objects.
:vartype next_link: str
:ivar value: A list of operations supported by the Microsoft.IoTCentral resource provider.
:vartype value: list[~azure.mgmt.iotcentral.models.Operation]
"""
_validation = {
"value": {"readonly": True},
}
_attribute_map = {
"next_link": {"key": "nextLink", "type": "str"},
"value": {"key": "value", "type": "[Operation]"},
}
def __init__(self, *, next_link: Optional[str] = None, **kwargs):
"""
:keyword next_link: The link used to get the next page of IoT Central description objects.
:paramtype next_link: str
"""
super().__init__(**kwargs)
self.next_link = next_link
self.value = None
class SystemAssignedServiceIdentity(_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.
:ivar principal_id: The service principal ID of the system assigned identity. This property
will only be provided for a system assigned identity.
:vartype principal_id: str
:ivar tenant_id: The tenant ID of the system assigned identity. This property will only be
provided for a system assigned identity.
:vartype tenant_id: str
:ivar type: Type of managed service identity (either system assigned, or none). Required. Known
values are: "None" and "SystemAssigned".
:vartype type: str or ~azure.mgmt.iotcentral.models.SystemAssignedServiceIdentityType
"""
_validation = {
"principal_id": {"readonly": True},
"tenant_id": {"readonly": True},
"type": {"required": True},
}
_attribute_map = {
"principal_id": {"key": "principalId", "type": "str"},
"tenant_id": {"key": "tenantId", "type": "str"},
"type": {"key": "type", "type": "str"},
}
def __init__(self, *, type: Union[str, "_models.SystemAssignedServiceIdentityType"], **kwargs):
"""
:keyword type: Type of managed service identity (either system assigned, or none). Required.
Known values are: "None" and "SystemAssigned".
:paramtype type: str or ~azure.mgmt.iotcentral.models.SystemAssignedServiceIdentityType
"""
super().__init__(**kwargs)
self.principal_id = None
self.tenant_id = None
self.type = type
|