-
Notifications
You must be signed in to change notification settings - Fork 232
/
azure.batch.models.SecurityProfile.yml
155 lines (140 loc) · 5.09 KB
/
azure.batch.models.SecurityProfile.yml
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
### YamlMime:PythonClass
uid: azure.batch.models.SecurityProfile
name: SecurityProfile
fullName: azure.batch.models.SecurityProfile
module: azure.batch.models
inheritances:
- msrest.serialization.Model
summary: 'Specifies the security profile settings for the virtual machine or virtual
machine scale set.'
constructor:
syntax: 'SecurityProfile(*, security_type=None, encryption_at_host: bool = None,
uefi_settings=None, **kwargs)'
parameters:
- name: security_type
description: 'Possible values include: ''trustedLaunch'''
isRequired: true
types:
- <xref:str>
- <xref:azure.batch.models.SecurityTypes>
- name: encryption_at_host
description: 'This property can be used by user in the
request to enable or disable the Host Encryption for the virtual machine
or virtual machine scale set. This will enable the encryption for all the
disks including Resource/Temp disk at host itself.'
isRequired: true
types:
- <xref:bool>
- name: uefi_settings
description: 'Specifies the security settings like secure boot and
vTPM used while creating the virtual machine. Specifies the security
settings like secure boot and vTPM used while creating the virtual
machine.'
isRequired: true
types:
- <xref:azure.batch.models.UefiSettings>
keywordOnlyParameters:
- name: security_type
isRequired: true
- name: encryption_at_host
isRequired: true
- name: uefi_settings
isRequired: true
methods:
- uid: azure.batch.models.SecurityProfile.as_dict
name: as_dict
summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
\ optionally use a callback as parameter:\n\nKey is the attribute name used in\
\ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
\ in this object.\n\nThe string returned will be used to serialize the key.\n\
If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
\ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
\ pass the kwargs is_xml=True."
signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
**kwargs)
parameters:
- name: key_transformer
description: A key transformer function.
types:
- <xref:function>
- name: keep_readonly
defaultValue: 'True'
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.batch.models.SecurityProfile.deserialize
name: deserialize
summary: Parse a str using the RestAPI syntax and return a model.
signature: deserialize(data, content_type=None)
parameters:
- name: data
description: A str using RestAPI structure. JSON by default.
isRequired: true
types:
- <xref:str>
- name: content_type
description: JSON by default, set application/xml if XML.
defaultValue: None
types:
- <xref:str>
return:
description: An instance of this model
exceptions:
- type: DeserializationError if something went wrong
- uid: azure.batch.models.SecurityProfile.enable_additional_properties_sending
name: enable_additional_properties_sending
signature: enable_additional_properties_sending()
- uid: azure.batch.models.SecurityProfile.from_dict
name: from_dict
summary: 'Parse a dict using given key extractor return a model.
By default consider key
extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor
and last_rest_key_case_insensitive_extractor)'
signature: from_dict(data, key_extractors=None, content_type=None)
parameters:
- name: data
description: A dict using RestAPI structure
isRequired: true
types:
- <xref:dict>
- name: content_type
description: JSON by default, set application/xml if XML.
defaultValue: None
types:
- <xref:str>
- name: key_extractors
defaultValue: None
return:
description: An instance of this model
exceptions:
- type: DeserializationError if something went wrong
- uid: azure.batch.models.SecurityProfile.is_xml_model
name: is_xml_model
signature: is_xml_model()
- uid: azure.batch.models.SecurityProfile.serialize
name: serialize
summary: 'Return the JSON that would be sent to azure from this model.
This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.
If you want XML serialization, you can pass the kwargs is_xml=True.'
signature: serialize(keep_readonly=False, **kwargs)
parameters:
- name: keep_readonly
description: If you want to serialize the readonly attributes
defaultValue: 'False'
types:
- <xref:bool>
return:
description: A dict JSON compatible object
types:
- <xref:dict>
- uid: azure.batch.models.SecurityProfile.validate
name: validate
summary: Validate this model recursively and return a list of ValidationError.
signature: validate()
return:
description: A list of validation error
types:
- <xref:list>