Package com.azure.resourcemanager.apimanagement.models

Interface AccessInformationContract

public interface AccessInformationContract

An immutable client-side representation of AccessInformationContract.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AccessInformationContract.Definition	The entirety of the AccessInformationContract definition.
static interface	AccessInformationContract.DefinitionStages	The AccessInformationContract definition stages.
static interface	AccessInformationContract.Update	The template for AccessInformationContract update.
static interface	AccessInformationContract.UpdateStages	The AccessInformationContract update stages.

Method Summary

Modifier and Type	Method	Description
Boolean	enabled()	Gets the enabled property: Determines whether direct access is enabled.
String	id()	Gets the id property: Fully qualified resource Id for the resource.
String	idPropertiesId()	Gets the idPropertiesId property: Access Information type ('access' or 'gitAccess').
AccessInformationContractInner	innerModel()	Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.AccessInformationContractInner object.
AccessInformationSecretsContract	listSecrets()	Get tenant access information details.
com.azure.core.http.rest.Response<AccessInformationSecretsContract>	listSecretsWithResponse(com.azure.core.util.Context context)	Get tenant access information details.
String	name()	Gets the name property: The name of the resource.
String	principalId()	Gets the principalId property: Principal (User) Identifier.
AccessInformationContract	refresh()	Refreshes the resource to sync with Azure.
AccessInformationContract	refresh(com.azure.core.util.Context context)	Refreshes the resource to sync with Azure.
void	regeneratePrimaryKey()	Regenerate primary access key.
com.azure.core.http.rest.Response<Void>	regeneratePrimaryKeyWithResponse(com.azure.core.util.Context context)	Regenerate primary access key.
void	regenerateSecondaryKey()	Regenerate secondary access key.
com.azure.core.http.rest.Response<Void>	regenerateSecondaryKeyWithResponse(com.azure.core.util.Context context)	Regenerate secondary access key.
String	type()	Gets the type property: The type of the resource.
AccessInformationContract.Update	update()	Begins update for the AccessInformationContract resource.

Method Detail

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.

idPropertiesId

String idPropertiesId()

Gets the idPropertiesId property: Access Information type ('access' or 'gitAccess').

Returns:

the idPropertiesId value.

principalId

String principalId()

Gets the principalId property: Principal (User) Identifier.

Returns:

the principalId value.

enabled

Boolean enabled()

Gets the enabled property: Determines whether direct access is enabled.

Returns:

the enabled value.

innerModel

AccessInformationContractInner innerModel()

Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.AccessInformationContractInner object.

Returns:

the inner object.

update

AccessInformationContract.Update update()

Begins update for the AccessInformationContract resource.

Returns:

the stage of resource update.

refresh

AccessInformationContract refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

AccessInformationContract refresh(com.azure.core.util.Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

regeneratePrimaryKey

void regeneratePrimaryKey()

Regenerate primary access key.

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.

regeneratePrimaryKeyWithResponse

com.azure.core.http.rest.Response<Void> regeneratePrimaryKeyWithResponse(com.azure.core.util.Context context)

Regenerate primary access key.

Parameters:

context - The context to associate with this operation.

Returns:

the Response.

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.

regenerateSecondaryKey

void regenerateSecondaryKey()

Regenerate secondary access key.

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.

regenerateSecondaryKeyWithResponse

com.azure.core.http.rest.Response<Void> regenerateSecondaryKeyWithResponse(com.azure.core.util.Context context)

Regenerate secondary access key.

Parameters:

context - The context to associate with this operation.

Returns:

the Response.

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

AccessInformationSecretsContract listSecrets()

Get tenant access information details.

Returns:

tenant access information details.

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.

listSecretsWithResponse

com.azure.core.http.rest.Response<AccessInformationSecretsContract> listSecretsWithResponse(com.azure.core.util.Context context)

Get tenant access information details.

Parameters:

context - The context to associate with this operation.

Returns:

tenant access information details.

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.