File: _models_py3.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (639 lines) | stat: -rw-r--r-- 23,118 bytes parent folder | download
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
# 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 Any, Dict, List, Optional, TYPE_CHECKING, Union

from .. import _serialization

if TYPE_CHECKING:
    # pylint: disable=unused-import,ungrouped-imports
    from .. import models as _models


class ContainerHostMapping(_serialization.Model):
    """Container host mapping object specifying the Container host resource ID and its associated
    Controller resource.

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

    :ivar container_host_resource_id: ARM ID of the Container Host resource.
    :vartype container_host_resource_id: str
    :ivar mapped_controller_resource_id: ARM ID of the mapped Controller resource.
    :vartype mapped_controller_resource_id: str
    """

    _validation = {
        "mapped_controller_resource_id": {"readonly": True},
    }

    _attribute_map = {
        "container_host_resource_id": {"key": "containerHostResourceId", "type": "str"},
        "mapped_controller_resource_id": {"key": "mappedControllerResourceId", "type": "str"},
    }

    def __init__(self, *, container_host_resource_id: Optional[str] = None, **kwargs: Any) -> None:
        """
        :keyword container_host_resource_id: ARM ID of the Container Host resource.
        :paramtype container_host_resource_id: str
        """
        super().__init__(**kwargs)
        self.container_host_resource_id = container_host_resource_id
        self.mapped_controller_resource_id = None


class Resource(_serialization.Model):
    """An Azure resource.

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

    :ivar id: Fully qualified resource Id for the resource.
    :vartype id: str
    :ivar name: The name of the resource.
    :vartype name: str
    :ivar type: The type of the resource.
    :vartype type: str
    """

    _validation = {
        "id": {"readonly": True},
        "name": {"readonly": True},
        "type": {"readonly": True},
    }

    _attribute_map = {
        "id": {"key": "id", "type": "str"},
        "name": {"key": "name", "type": "str"},
        "type": {"key": "type", "type": "str"},
    }

    def __init__(self, **kwargs: Any) -> None:
        """ """
        super().__init__(**kwargs)
        self.id = None
        self.name = None
        self.type = None


class TrackedResource(Resource):
    """The resource model definition for a ARM tracked top level resource.

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

    :ivar id: Fully qualified resource Id for the resource.
    :vartype id: str
    :ivar name: The name of the resource.
    :vartype name: str
    :ivar type: The type of the resource.
    :vartype type: str
    :ivar tags: Tags for the Azure resource.
    :vartype tags: dict[str, str]
    :ivar location: Region where the Azure resource is located.
    :vartype location: str
    """

    _validation = {
        "id": {"readonly": True},
        "name": {"readonly": True},
        "type": {"readonly": True},
    }

    _attribute_map = {
        "id": {"key": "id", "type": "str"},
        "name": {"key": "name", "type": "str"},
        "type": {"key": "type", "type": "str"},
        "tags": {"key": "tags", "type": "{str}"},
        "location": {"key": "location", "type": "str"},
    }

    def __init__(self, *, tags: Optional[Dict[str, str]] = None, location: Optional[str] = None, **kwargs: Any) -> None:
        """
        :keyword tags: Tags for the Azure resource.
        :paramtype tags: dict[str, str]
        :keyword location: Region where the Azure resource is located.
        :paramtype location: str
        """
        super().__init__(**kwargs)
        self.tags = tags
        self.location = location


class Controller(TrackedResource):  # pylint: disable=too-many-instance-attributes
    """Controller.

    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: Fully qualified resource Id for the resource.
    :vartype id: str
    :ivar name: The name of the resource.
    :vartype name: str
    :ivar type: The type of the resource.
    :vartype type: str
    :ivar tags: Tags for the Azure resource.
    :vartype tags: dict[str, str]
    :ivar location: Region where the Azure resource is located.
    :vartype location: str
    :ivar sku: Model representing SKU for Azure Dev Spaces Controller. Required.
    :vartype sku: ~azure.mgmt.devspaces.models.Sku
    :ivar provisioning_state: Provisioning state of the Azure Dev Spaces Controller. Known values
     are: "Succeeded", "Failed", "Canceled", "Updating", "Creating", "Deleting", and "Deleted".
    :vartype provisioning_state: str or ~azure.mgmt.devspaces.models.ProvisioningState
    :ivar host_suffix: DNS suffix for public endpoints running in the Azure Dev Spaces Controller.
    :vartype host_suffix: str
    :ivar data_plane_fqdn: DNS name for accessing DataPlane services.
    :vartype data_plane_fqdn: str
    :ivar target_container_host_api_server_fqdn: DNS of the target container host's API server.
    :vartype target_container_host_api_server_fqdn: str
    :ivar target_container_host_resource_id: Resource ID of the target container host. Required.
    :vartype target_container_host_resource_id: str
    :ivar target_container_host_credentials_base64: Credentials of the target container host
     (base64). Required.
    :vartype target_container_host_credentials_base64: str
    """

    _validation = {
        "id": {"readonly": True},
        "name": {"readonly": True},
        "type": {"readonly": True},
        "sku": {"required": True},
        "provisioning_state": {"readonly": True},
        "host_suffix": {"readonly": True},
        "data_plane_fqdn": {"readonly": True},
        "target_container_host_api_server_fqdn": {"readonly": True},
        "target_container_host_resource_id": {"required": True},
        "target_container_host_credentials_base64": {"required": True},
    }

    _attribute_map = {
        "id": {"key": "id", "type": "str"},
        "name": {"key": "name", "type": "str"},
        "type": {"key": "type", "type": "str"},
        "tags": {"key": "tags", "type": "{str}"},
        "location": {"key": "location", "type": "str"},
        "sku": {"key": "sku", "type": "Sku"},
        "provisioning_state": {"key": "properties.provisioningState", "type": "str"},
        "host_suffix": {"key": "properties.hostSuffix", "type": "str"},
        "data_plane_fqdn": {"key": "properties.dataPlaneFqdn", "type": "str"},
        "target_container_host_api_server_fqdn": {"key": "properties.targetContainerHostApiServerFqdn", "type": "str"},
        "target_container_host_resource_id": {"key": "properties.targetContainerHostResourceId", "type": "str"},
        "target_container_host_credentials_base64": {
            "key": "properties.targetContainerHostCredentialsBase64",
            "type": "str",
        },
    }

    def __init__(
        self,
        *,
        sku: "_models.Sku",
        target_container_host_resource_id: str,
        target_container_host_credentials_base64: str,
        tags: Optional[Dict[str, str]] = None,
        location: Optional[str] = None,
        **kwargs: Any
    ) -> None:
        """
        :keyword tags: Tags for the Azure resource.
        :paramtype tags: dict[str, str]
        :keyword location: Region where the Azure resource is located.
        :paramtype location: str
        :keyword sku: Model representing SKU for Azure Dev Spaces Controller. Required.
        :paramtype sku: ~azure.mgmt.devspaces.models.Sku
        :keyword target_container_host_resource_id: Resource ID of the target container host. Required.
        :paramtype target_container_host_resource_id: str
        :keyword target_container_host_credentials_base64: Credentials of the target container host
         (base64). Required.
        :paramtype target_container_host_credentials_base64: str
        """
        super().__init__(tags=tags, location=location, **kwargs)
        self.sku = sku
        self.provisioning_state = None
        self.host_suffix = None
        self.data_plane_fqdn = None
        self.target_container_host_api_server_fqdn = None
        self.target_container_host_resource_id = target_container_host_resource_id
        self.target_container_host_credentials_base64 = target_container_host_credentials_base64


class ControllerConnectionDetails(_serialization.Model):
    """ControllerConnectionDetails.

    :ivar orchestrator_specific_connection_details: Base class for types that supply values used to
     connect to container orchestrators.
    :vartype orchestrator_specific_connection_details:
     ~azure.mgmt.devspaces.models.OrchestratorSpecificConnectionDetails
    """

    _attribute_map = {
        "orchestrator_specific_connection_details": {
            "key": "orchestratorSpecificConnectionDetails",
            "type": "OrchestratorSpecificConnectionDetails",
        },
    }

    def __init__(
        self,
        *,
        orchestrator_specific_connection_details: Optional["_models.OrchestratorSpecificConnectionDetails"] = None,
        **kwargs: Any
    ) -> None:
        """
        :keyword orchestrator_specific_connection_details: Base class for types that supply values used
         to connect to container orchestrators.
        :paramtype orchestrator_specific_connection_details:
         ~azure.mgmt.devspaces.models.OrchestratorSpecificConnectionDetails
        """
        super().__init__(**kwargs)
        self.orchestrator_specific_connection_details = orchestrator_specific_connection_details


class ControllerConnectionDetailsList(_serialization.Model):
    """ControllerConnectionDetailsList.

    :ivar connection_details_list: List of Azure Dev Spaces Controller connection details.
    :vartype connection_details_list:
     list[~azure.mgmt.devspaces.models.ControllerConnectionDetails]
    """

    _attribute_map = {
        "connection_details_list": {"key": "connectionDetailsList", "type": "[ControllerConnectionDetails]"},
    }

    def __init__(
        self, *, connection_details_list: Optional[List["_models.ControllerConnectionDetails"]] = None, **kwargs: Any
    ) -> None:
        """
        :keyword connection_details_list: List of Azure Dev Spaces Controller connection details.
        :paramtype connection_details_list:
         list[~azure.mgmt.devspaces.models.ControllerConnectionDetails]
        """
        super().__init__(**kwargs)
        self.connection_details_list = connection_details_list


class ControllerList(_serialization.Model):
    """ControllerList.

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

    :ivar value: List of Azure Dev Spaces Controllers.
    :vartype value: list[~azure.mgmt.devspaces.models.Controller]
    :ivar next_link: The URI that can be used to request the next page for list of Azure Dev Spaces
     Controllers.
    :vartype next_link: str
    """

    _validation = {
        "next_link": {"readonly": True},
    }

    _attribute_map = {
        "value": {"key": "value", "type": "[Controller]"},
        "next_link": {"key": "nextLink", "type": "str"},
    }

    def __init__(self, *, value: Optional[List["_models.Controller"]] = None, **kwargs: Any) -> None:
        """
        :keyword value: List of Azure Dev Spaces Controllers.
        :paramtype value: list[~azure.mgmt.devspaces.models.Controller]
        """
        super().__init__(**kwargs)
        self.value = value
        self.next_link = None


class ControllerUpdateParameters(_serialization.Model):
    """Parameters for updating an Azure Dev Spaces Controller.

    :ivar tags: Tags for the Azure Dev Spaces Controller.
    :vartype tags: dict[str, str]
    :ivar target_container_host_credentials_base64: Credentials of the target container host
     (base64).
    :vartype target_container_host_credentials_base64: str
    """

    _attribute_map = {
        "tags": {"key": "tags", "type": "{str}"},
        "target_container_host_credentials_base64": {
            "key": "properties.targetContainerHostCredentialsBase64",
            "type": "str",
        },
    }

    def __init__(
        self,
        *,
        tags: Optional[Dict[str, str]] = None,
        target_container_host_credentials_base64: Optional[str] = None,
        **kwargs: Any
    ) -> None:
        """
        :keyword tags: Tags for the Azure Dev Spaces Controller.
        :paramtype tags: dict[str, str]
        :keyword target_container_host_credentials_base64: Credentials of the target container host
         (base64).
        :paramtype target_container_host_credentials_base64: str
        """
        super().__init__(**kwargs)
        self.tags = tags
        self.target_container_host_credentials_base64 = target_container_host_credentials_base64


class DevSpacesErrorResponse(_serialization.Model):
    """Error response indicates that the service is not able to process the incoming request. The
    reason is provided in the error message.

    :ivar error: The details of the error.
    :vartype error: ~azure.mgmt.devspaces.models.ErrorDetails
    """

    _attribute_map = {
        "error": {"key": "error", "type": "ErrorDetails"},
    }

    def __init__(self, *, error: Optional["_models.ErrorDetails"] = None, **kwargs: Any) -> None:
        """
        :keyword error: The details of the error.
        :paramtype error: ~azure.mgmt.devspaces.models.ErrorDetails
        """
        super().__init__(**kwargs)
        self.error = error


class ErrorDetails(_serialization.Model):
    """ErrorDetails.

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

    :ivar code: Status code for the error.
    :vartype code: str
    :ivar message: Error message describing the error in detail.
    :vartype message: str
    :ivar target: The target of the particular error.
    :vartype target: str
    """

    _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"},
    }

    def __init__(self, **kwargs: Any) -> None:
        """ """
        super().__init__(**kwargs)
        self.code = None
        self.message = None
        self.target = None


class OrchestratorSpecificConnectionDetails(_serialization.Model):
    """Base class for types that supply values used to connect to container orchestrators.

    You probably want to use the sub-classes and not this class directly. Known sub-classes are:
    KubernetesConnectionDetails

    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 instance_type: Gets the Instance type. Required.
    :vartype instance_type: str
    """

    _validation = {
        "instance_type": {"required": True, "readonly": True},
    }

    _attribute_map = {
        "instance_type": {"key": "instanceType", "type": "str"},
    }

    _subtype_map = {"instance_type": {"Kubernetes": "KubernetesConnectionDetails"}}

    def __init__(self, **kwargs: Any) -> None:
        """ """
        super().__init__(**kwargs)
        self.instance_type: Optional[str] = None


class KubernetesConnectionDetails(OrchestratorSpecificConnectionDetails):
    """Contains information used to connect to a Kubernetes cluster.

    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 instance_type: Gets the Instance type. Required.
    :vartype instance_type: str
    :ivar kube_config: Gets the kubeconfig for the cluster.
    :vartype kube_config: str
    """

    _validation = {
        "instance_type": {"required": True, "readonly": True},
    }

    _attribute_map = {
        "instance_type": {"key": "instanceType", "type": "str"},
        "kube_config": {"key": "kubeConfig", "type": "str"},
    }

    def __init__(self, *, kube_config: Optional[str] = None, **kwargs: Any) -> None:
        """
        :keyword kube_config: Gets the kubeconfig for the cluster.
        :paramtype kube_config: str
        """
        super().__init__(**kwargs)
        self.instance_type: str = "Kubernetes"
        self.kube_config = kube_config


class ListConnectionDetailsParameters(_serialization.Model):
    """Parameters for listing connection details of an Azure Dev Spaces Controller.

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

    :ivar target_container_host_resource_id: Resource ID of the target container host mapped to the
     Azure Dev Spaces Controller. Required.
    :vartype target_container_host_resource_id: str
    """

    _validation = {
        "target_container_host_resource_id": {"required": True},
    }

    _attribute_map = {
        "target_container_host_resource_id": {"key": "targetContainerHostResourceId", "type": "str"},
    }

    def __init__(self, *, target_container_host_resource_id: str, **kwargs: Any) -> None:
        """
        :keyword target_container_host_resource_id: Resource ID of the target container host mapped to
         the Azure Dev Spaces Controller. Required.
        :paramtype target_container_host_resource_id: str
        """
        super().__init__(**kwargs)
        self.target_container_host_resource_id = target_container_host_resource_id


class ResourceProviderOperationDefinition(_serialization.Model):
    """ResourceProviderOperationDefinition.

    :ivar name: Resource provider operation name.
    :vartype name: str
    :ivar display:
    :vartype display: ~azure.mgmt.devspaces.models.ResourceProviderOperationDisplay
    """

    _attribute_map = {
        "name": {"key": "name", "type": "str"},
        "display": {"key": "display", "type": "ResourceProviderOperationDisplay"},
    }

    def __init__(
        self,
        *,
        name: Optional[str] = None,
        display: Optional["_models.ResourceProviderOperationDisplay"] = None,
        **kwargs: Any
    ) -> None:
        """
        :keyword name: Resource provider operation name.
        :paramtype name: str
        :keyword display:
        :paramtype display: ~azure.mgmt.devspaces.models.ResourceProviderOperationDisplay
        """
        super().__init__(**kwargs)
        self.name = name
        self.display = display


class ResourceProviderOperationDisplay(_serialization.Model):
    """ResourceProviderOperationDisplay.

    :ivar provider: Name of the resource provider.
    :vartype provider: str
    :ivar resource: Name of the resource type.
    :vartype resource: str
    :ivar operation: Name of the resource provider operation.
    :vartype operation: str
    :ivar description: Description of the resource provider operation.
    :vartype description: str
    """

    _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,
        *,
        provider: Optional[str] = None,
        resource: Optional[str] = None,
        operation: Optional[str] = None,
        description: Optional[str] = None,
        **kwargs: Any
    ) -> None:
        """
        :keyword provider: Name of the resource provider.
        :paramtype provider: str
        :keyword resource: Name of the resource type.
        :paramtype resource: str
        :keyword operation: Name of the resource provider operation.
        :paramtype operation: str
        :keyword description: Description of the resource provider operation.
        :paramtype description: str
        """
        super().__init__(**kwargs)
        self.provider = provider
        self.resource = resource
        self.operation = operation
        self.description = description


class ResourceProviderOperationList(_serialization.Model):
    """ResourceProviderOperationList.

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

    :ivar value: Resource provider operations list.
    :vartype value: list[~azure.mgmt.devspaces.models.ResourceProviderOperationDefinition]
    :ivar next_link: The URI that can be used to request the next page for list of Azure
     operations.
    :vartype next_link: str
    """

    _validation = {
        "next_link": {"readonly": True},
    }

    _attribute_map = {
        "value": {"key": "value", "type": "[ResourceProviderOperationDefinition]"},
        "next_link": {"key": "nextLink", "type": "str"},
    }

    def __init__(
        self, *, value: Optional[List["_models.ResourceProviderOperationDefinition"]] = None, **kwargs: Any
    ) -> None:
        """
        :keyword value: Resource provider operations list.
        :paramtype value: list[~azure.mgmt.devspaces.models.ResourceProviderOperationDefinition]
        """
        super().__init__(**kwargs)
        self.value = value
        self.next_link = None


class Sku(_serialization.Model):
    """Model representing SKU for Azure Dev Spaces Controller.

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

    :ivar name: The name of the SKU for Azure Dev Spaces Controller. Required. "S1"
    :vartype name: str or ~azure.mgmt.devspaces.models.SkuName
    :ivar tier: The tier of the SKU for Azure Dev Spaces Controller. "Standard"
    :vartype tier: str or ~azure.mgmt.devspaces.models.SkuTier
    """

    _validation = {
        "name": {"required": True},
    }

    _attribute_map = {
        "name": {"key": "name", "type": "str"},
        "tier": {"key": "tier", "type": "str"},
    }

    def __init__(
        self,
        *,
        name: Union[str, "_models.SkuName"],
        tier: Optional[Union[str, "_models.SkuTier"]] = None,
        **kwargs: Any
    ) -> None:
        """
        :keyword name: The name of the SKU for Azure Dev Spaces Controller. Required. "S1"
        :paramtype name: str or ~azure.mgmt.devspaces.models.SkuName
        :keyword tier: The tier of the SKU for Azure Dev Spaces Controller. "Standard"
        :paramtype tier: str or ~azure.mgmt.devspaces.models.SkuTier
        """
        super().__init__(**kwargs)
        self.name = name
        self.tier = tier