222 строки
18 KiB
YAML
222 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.appcontainers.models.Login"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login"
|
|
name: "Login"
|
|
nameWithType: "Login"
|
|
summary: "The configuration settings of the login flow of users using Container<wbr>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 **Login**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.Login()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.Login()"
|
|
name: "Login()"
|
|
nameWithType: "Login.Login()"
|
|
summary: "Creates an instance of Login class."
|
|
syntax: "public Login()"
|
|
desc: "Creates an instance of Login class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.allowedExternalRedirectUrls()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.allowedExternalRedirectUrls()"
|
|
name: "allowedExternalRedirectUrls()"
|
|
nameWithType: "Login.allowedExternalRedirectUrls()"
|
|
summary: "Get the allowed<wbr>External<wbr>Redirect<wbr>Urls property: External URLs that can be redirected to as part of logging in or logging out of the app."
|
|
syntax: "public List<String> allowedExternalRedirectUrls()"
|
|
desc: "Get the allowedExternalRedirectUrls property: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed."
|
|
returns:
|
|
description: "the allowedExternalRedirectUrls value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.cookieExpiration()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.cookieExpiration()"
|
|
name: "cookieExpiration()"
|
|
nameWithType: "Login.cookieExpiration()"
|
|
summary: "Get the cookie<wbr>Expiration property: The configuration settings of the session cookie's expiration."
|
|
syntax: "public CookieExpiration cookieExpiration()"
|
|
desc: "Get the cookieExpiration property: The configuration settings of the session cookie's expiration."
|
|
returns:
|
|
description: "the cookieExpiration value."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.CookieExpiration?alt=com.azure.resourcemanager.appcontainers.models.CookieExpiration&text=CookieExpiration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "Login.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Login 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 Login fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the Login."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of Login from the JsonReader."
|
|
returns:
|
|
description: "An instance of Login if the JsonReader was pointing to an instance of it, or null if it was pointing to\n JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.nonce()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.nonce()"
|
|
name: "nonce()"
|
|
nameWithType: "Login.nonce()"
|
|
summary: "Get the nonce property: The configuration settings of the nonce used in the login flow."
|
|
syntax: "public Nonce nonce()"
|
|
desc: "Get the nonce property: The configuration settings of the nonce used in the login flow."
|
|
returns:
|
|
description: "the nonce value."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Nonce?alt=com.azure.resourcemanager.appcontainers.models.Nonce&text=Nonce\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.preserveUrlFragmentsForLogins()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.preserveUrlFragmentsForLogins()"
|
|
name: "preserveUrlFragmentsForLogins()"
|
|
nameWithType: "Login.preserveUrlFragmentsForLogins()"
|
|
summary: "Get the preserve<wbr>Url<wbr>Fragments<wbr>For<wbr>Logins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>."
|
|
syntax: "public Boolean preserveUrlFragmentsForLogins()"
|
|
desc: "Get the preserveUrlFragmentsForLogins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>."
|
|
returns:
|
|
description: "the preserveUrlFragmentsForLogins value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.routes()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.routes()"
|
|
name: "routes()"
|
|
nameWithType: "Login.routes()"
|
|
summary: "Get the routes property: The routes that specify the endpoints used for login and logout requests."
|
|
syntax: "public LoginRoutes routes()"
|
|
desc: "Get the routes property: The routes that specify the endpoints used for login and logout requests."
|
|
returns:
|
|
description: "the routes value."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.LoginRoutes?alt=com.azure.resourcemanager.appcontainers.models.LoginRoutes&text=LoginRoutes\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "Login.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.appcontainers.models.Login.tokenStore()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.tokenStore()"
|
|
name: "tokenStore()"
|
|
nameWithType: "Login.tokenStore()"
|
|
summary: "Get the token<wbr>Store property: The configuration settings of the token store."
|
|
syntax: "public TokenStore tokenStore()"
|
|
desc: "Get the tokenStore property: The configuration settings of the token store."
|
|
returns:
|
|
description: "the tokenStore value."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.TokenStore?alt=com.azure.resourcemanager.appcontainers.models.TokenStore&text=TokenStore\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.validate()"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.validate()"
|
|
name: "validate()"
|
|
nameWithType: "Login.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.withAllowedExternalRedirectUrls(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.withAllowedExternalRedirectUrls(List<String> allowedExternalRedirectUrls)"
|
|
name: "withAllowedExternalRedirectUrls(List<String> allowedExternalRedirectUrls)"
|
|
nameWithType: "Login.withAllowedExternalRedirectUrls(List<String> allowedExternalRedirectUrls)"
|
|
summary: "Set the allowed<wbr>External<wbr>Redirect<wbr>Urls property: External URLs that can be redirected to as part of logging in or logging out of the app."
|
|
parameters:
|
|
- description: "the allowedExternalRedirectUrls value to set."
|
|
name: "allowedExternalRedirectUrls"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public Login withAllowedExternalRedirectUrls(List<String> allowedExternalRedirectUrls)"
|
|
desc: "Set the allowedExternalRedirectUrls property: External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed."
|
|
returns:
|
|
description: "the Login object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.withCookieExpiration(com.azure.resourcemanager.appcontainers.models.CookieExpiration)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.withCookieExpiration(CookieExpiration cookieExpiration)"
|
|
name: "withCookieExpiration(CookieExpiration cookieExpiration)"
|
|
nameWithType: "Login.withCookieExpiration(CookieExpiration cookieExpiration)"
|
|
summary: "Set the cookie<wbr>Expiration property: The configuration settings of the session cookie's expiration."
|
|
parameters:
|
|
- description: "the cookieExpiration value to set."
|
|
name: "cookieExpiration"
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.CookieExpiration?alt=com.azure.resourcemanager.appcontainers.models.CookieExpiration&text=CookieExpiration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Login withCookieExpiration(CookieExpiration cookieExpiration)"
|
|
desc: "Set the cookieExpiration property: The configuration settings of the session cookie's expiration."
|
|
returns:
|
|
description: "the Login object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.withNonce(com.azure.resourcemanager.appcontainers.models.Nonce)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.withNonce(Nonce nonce)"
|
|
name: "withNonce(Nonce nonce)"
|
|
nameWithType: "Login.withNonce(Nonce nonce)"
|
|
summary: "Set the nonce property: The configuration settings of the nonce used in the login flow."
|
|
parameters:
|
|
- description: "the nonce value to set."
|
|
name: "nonce"
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Nonce?alt=com.azure.resourcemanager.appcontainers.models.Nonce&text=Nonce\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Login withNonce(Nonce nonce)"
|
|
desc: "Set the nonce property: The configuration settings of the nonce used in the login flow."
|
|
returns:
|
|
description: "the Login object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.withPreserveUrlFragmentsForLogins(java.lang.Boolean)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)"
|
|
name: "withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)"
|
|
nameWithType: "Login.withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)"
|
|
summary: "Set the preserve<wbr>Url<wbr>Fragments<wbr>For<wbr>Logins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>."
|
|
parameters:
|
|
- description: "the preserveUrlFragmentsForLogins value to set."
|
|
name: "preserveUrlFragmentsForLogins"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public Login withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)"
|
|
desc: "Set the preserveUrlFragmentsForLogins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>."
|
|
returns:
|
|
description: "the Login object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.withRoutes(com.azure.resourcemanager.appcontainers.models.LoginRoutes)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.withRoutes(LoginRoutes routes)"
|
|
name: "withRoutes(LoginRoutes routes)"
|
|
nameWithType: "Login.withRoutes(LoginRoutes routes)"
|
|
summary: "Set the routes property: The routes that specify the endpoints used for login and logout requests."
|
|
parameters:
|
|
- description: "the routes value to set."
|
|
name: "routes"
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.LoginRoutes?alt=com.azure.resourcemanager.appcontainers.models.LoginRoutes&text=LoginRoutes\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Login withRoutes(LoginRoutes routes)"
|
|
desc: "Set the routes property: The routes that specify the endpoints used for login and logout requests."
|
|
returns:
|
|
description: "the Login object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.appcontainers.models.Login.withTokenStore(com.azure.resourcemanager.appcontainers.models.TokenStore)"
|
|
fullName: "com.azure.resourcemanager.appcontainers.models.Login.withTokenStore(TokenStore tokenStore)"
|
|
name: "withTokenStore(TokenStore tokenStore)"
|
|
nameWithType: "Login.withTokenStore(TokenStore tokenStore)"
|
|
summary: "Set the token<wbr>Store property: The configuration settings of the token store."
|
|
parameters:
|
|
- description: "the tokenStore value to set."
|
|
name: "tokenStore"
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.TokenStore?alt=com.azure.resourcemanager.appcontainers.models.TokenStore&text=TokenStore\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Login withTokenStore(TokenStore tokenStore)"
|
|
desc: "Set the tokenStore property: The configuration settings of the token store."
|
|
returns:
|
|
description: "the Login object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.appcontainers.models.Login?alt=com.azure.resourcemanager.appcontainers.models.Login&text=Login\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.appcontainers.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-appcontainers:1.0.0
|