Interface OpenidConnectProviderContract
public interface OpenidConnectProviderContract
An immutable client-side representation of OpenidConnectProviderContract.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceThe entirety of the OpenidConnectProviderContract definition.static interfaceThe OpenidConnectProviderContract definition stages.static interfaceThe template for OpenidConnectProviderContract update.static interfaceThe OpenidConnectProviderContract update stages. -
Method Summary
Modifier and TypeMethodDescriptionclientId()Gets the clientId property: Client ID of developer console which is the client application.Gets the clientSecret property: Client Secret of developer console which is the client application.Gets the description property: User-friendly description of OpenID Connect Provider.Gets the displayName property: User-friendly OpenID Connect Provider name.id()Gets the id property: Fully qualified resource Id for the resource.Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.OpenidConnectProviderContractInner object.Gets the client secret details of the OpenID Connect Provider.com.azure.core.http.rest.Response<ClientSecretContract> listSecretsWithResponse(com.azure.core.util.Context context) Gets the client secret details of the OpenID Connect Provider.Gets the metadataEndpoint property: Metadata endpoint URI.name()Gets the name property: The name of the resource.refresh()Refreshes the resource to sync with Azure.refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.Gets the name of the resource group.type()Gets the type property: The type of the resource.update()Begins update for the OpenidConnectProviderContract resource.Gets the useInApiDocumentation property: If true, the Open ID Connect provider will be used in the API documentation in the developer portal.Gets the useInTestConsole property: If true, the Open ID Connect provider may be used in the developer portal test console.
-
Method Details
-
id
String id()Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()Gets the type property: The type of the resource.- Returns:
- the type value.
-
displayName
String displayName()Gets the displayName property: User-friendly OpenID Connect Provider name.- Returns:
- the displayName value.
-
description
String description()Gets the description property: User-friendly description of OpenID Connect Provider.- Returns:
- the description value.
-
metadataEndpoint
String metadataEndpoint()Gets the metadataEndpoint property: Metadata endpoint URI.- Returns:
- the metadataEndpoint value.
-
clientId
String clientId()Gets the clientId property: Client ID of developer console which is the client application.- Returns:
- the clientId value.
-
clientSecret
String clientSecret()Gets the clientSecret property: Client Secret of developer console which is the client application.- Returns:
- the clientSecret value.
-
useInTestConsole
Boolean useInTestConsole()Gets the useInTestConsole property: If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided.- Returns:
- the useInTestConsole value.
-
useInApiDocumentation
Boolean useInApiDocumentation()Gets the useInApiDocumentation property: If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided.- Returns:
- the useInApiDocumentation value.
-
resourceGroupName
String resourceGroupName()Gets the name of the resource group.- Returns:
- the name of the resource group.
-
innerModel
OpenidConnectProviderContractInner innerModel()Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.OpenidConnectProviderContractInner object.- Returns:
- the inner object.
-
update
OpenidConnectProviderContract.Update update()Begins update for the OpenidConnectProviderContract resource.- Returns:
- the stage of resource update.
-
refresh
OpenidConnectProviderContract refresh()Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
Refreshes the resource to sync with Azure.- Parameters:
context- The context to associate with this operation.- Returns:
- the refreshed resource.
-
listSecretsWithResponse
com.azure.core.http.rest.Response<ClientSecretContract> listSecretsWithResponse(com.azure.core.util.Context context) Gets the client secret details of the OpenID Connect Provider.- Parameters:
context- The context to associate with this operation.- Returns:
- the client secret details of the OpenID Connect Provider.
- Throws:
IllegalArgumentException- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-
listSecrets
ClientSecretContract listSecrets()Gets the client secret details of the OpenID Connect Provider.- Returns:
- the client secret details of the OpenID Connect Provider.
- Throws:
com.azure.core.management.exception.ManagementException- thrown if the request is rejected by server.RuntimeException- all other wrapped checked exceptions if the request fails to be sent.
-