azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.a...

150 строки
11 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.appservice.models.AuthPlatform"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform"
name: "AuthPlatform"
nameWithType: "AuthPlatform"
summary: "The configuration settings of the platform of App Service Authentication/Authorization."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **AuthPlatform**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.appservice.models.AuthPlatform?alt=com.azure.resourcemanager.appservice.models.AuthPlatform&text=AuthPlatform\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.AuthPlatform()"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.AuthPlatform()"
name: "AuthPlatform()"
nameWithType: "AuthPlatform.AuthPlatform()"
summary: "Creates an instance of Auth<wbr>Platform class."
syntax: "public AuthPlatform()"
desc: "Creates an instance of AuthPlatform class."
methods:
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.configFilePath()"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.configFilePath()"
name: "configFilePath()"
nameWithType: "AuthPlatform.configFilePath()"
summary: "Get the config<wbr>File<wbr>Path property: The path of the config file containing auth settings if they come from a file."
syntax: "public String configFilePath()"
desc: "Get the configFilePath property: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory."
returns:
description: "the configFilePath value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.enabled()"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.enabled()"
name: "enabled()"
nameWithType: "AuthPlatform.enabled()"
summary: "Get the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>."
syntax: "public Boolean enabled()"
desc: "Get the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>."
returns:
description: "the enabled value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "AuthPlatform.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of Auth<wbr>Platform from the Json<wbr>Reader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
syntax: "public static AuthPlatform fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the AuthPlatform."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
desc: "Reads an instance of AuthPlatform from the JsonReader."
returns:
description: "An instance of AuthPlatform if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.AuthPlatform?alt=com.azure.resourcemanager.appservice.models.AuthPlatform&text=AuthPlatform\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.runtimeVersion()"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.runtimeVersion()"
name: "runtimeVersion()"
nameWithType: "AuthPlatform.runtimeVersion()"
summary: "Get the runtime<wbr>Version property: The Runtime<wbr>Version of the Authentication / Authorization feature in use for the current app."
syntax: "public String runtimeVersion()"
desc: "Get the runtimeVersion property: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module."
returns:
description: "the runtimeVersion value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "AuthPlatform.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.validate()"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.validate()"
name: "validate()"
nameWithType: "AuthPlatform.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.withConfigFilePath(java.lang.String)"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.withConfigFilePath(String configFilePath)"
name: "withConfigFilePath(String configFilePath)"
nameWithType: "AuthPlatform.withConfigFilePath(String configFilePath)"
summary: "Set the config<wbr>File<wbr>Path property: The path of the config file containing auth settings if they come from a file."
parameters:
- description: "the configFilePath value to set."
name: "configFilePath"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AuthPlatform withConfigFilePath(String configFilePath)"
desc: "Set the configFilePath property: The path of the config file containing auth settings if they come from a file. If the path is relative, base will the site's root directory."
returns:
description: "the AuthPlatform object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.AuthPlatform?alt=com.azure.resourcemanager.appservice.models.AuthPlatform&text=AuthPlatform\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.withEnabled(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.withEnabled(Boolean enabled)"
name: "withEnabled(Boolean enabled)"
nameWithType: "AuthPlatform.withEnabled(Boolean enabled)"
summary: "Set the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>."
parameters:
- description: "the enabled value to set."
name: "enabled"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public AuthPlatform withEnabled(Boolean enabled)"
desc: "Set the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>."
returns:
description: "the AuthPlatform object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.AuthPlatform?alt=com.azure.resourcemanager.appservice.models.AuthPlatform&text=AuthPlatform\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.appservice.models.AuthPlatform.withRuntimeVersion(java.lang.String)"
fullName: "com.azure.resourcemanager.appservice.models.AuthPlatform.withRuntimeVersion(String runtimeVersion)"
name: "withRuntimeVersion(String runtimeVersion)"
nameWithType: "AuthPlatform.withRuntimeVersion(String runtimeVersion)"
summary: "Set the runtime<wbr>Version property: The Runtime<wbr>Version of the Authentication / Authorization feature in use for the current app."
parameters:
- description: "the runtimeVersion value to set."
name: "runtimeVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public AuthPlatform withRuntimeVersion(String runtimeVersion)"
desc: "Set the runtimeVersion property: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module."
returns:
description: "the AuthPlatform object itself."
type: "<xref href=\"com.azure.resourcemanager.appservice.models.AuthPlatform?alt=com.azure.resourcemanager.appservice.models.AuthPlatform&text=AuthPlatform\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The configuration settings of the platform of App Service Authentication/Authorization."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.appservice.models.AuthPlatform?alt=com.azure.resourcemanager.appservice.models.AuthPlatform&text=AuthPlatform\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.appservice.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-appservice:2.44.0