Package com.azure.resourcemanager.cognitiveservices.models

Interface Account

public interface Account
An immutable client-side representation of Account.

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    etag()
    Gets the etag property: Resource Etag.
    String
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    Identity
    identity()
    Gets the identity property: Identity for the resource.
    AccountInner
    innerModel()
    Gets the inner com.azure.resourcemanager.cognitiveservices.fluent.models.AccountInner object.
    String
    kind()
    Gets the kind property: The Kind of the resource.
    ApiKeys
    listKeys()
    Lists the account keys for the specified Cognitive Services account.
    com.azure.core.http.rest.Response<ApiKeys>
    listKeysWithResponse(com.azure.core.util.Context context)
    Lists the account keys for the specified Cognitive Services account.
    String
    location()
    Gets the location property: The geo-location where the resource lives.
    String
    name()
    Gets the name property: The name of the resource.
    AccountProperties
    properties()
    Gets the properties property: Properties of Cognitive Services account.
    Account
    refresh()
    Refreshes the resource to sync with Azure.
    Account
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    ApiKeys
    regenerateKey(RegenerateKeyParameters parameters)
    Regenerates the specified account key for the specified Cognitive Services account.
    com.azure.core.http.rest.Response<ApiKeys>
    regenerateKeyWithResponse(RegenerateKeyParameters parameters, com.azure.core.util.Context context)
    Regenerates the specified account key for the specified Cognitive Services account.
    com.azure.core.management.Region
    region()
    Gets the region of the resource.
    String
    regionName()
    Gets the name of the resource region.
    String
    resourceGroupName()
    Gets the name of the resource group.
    Sku
    sku()
    Gets the sku property: The resource model definition representing SKU.
    com.azure.core.management.SystemData
    systemData()
    Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
    Map<String,String>
    tags()
    Gets the tags property: Resource tags.
    String
    type()
    Gets the type property: The type of the resource.
    Account.Update
    update()
    Begins update for the Account resource.

  • 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.

    • etag

      String etag()
      Gets the etag property: Resource Etag.
      Returns:
      the etag value.

    • kind

      String kind()
      Gets the kind property: The Kind of the resource.
      Returns:
      the kind value.

    • sku

      Sku sku()
      Gets the sku property: The resource model definition representing SKU.
      Returns:
      the sku value.

    • identity

      Identity identity()
      Gets the identity property: Identity for the resource.
      Returns:
      the identity value.

    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.

    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.

    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.

    • properties

      AccountProperties properties()
      Gets the properties property: Properties of Cognitive Services account.
      Returns:
      the properties value.

    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.

    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      AccountInner innerModel()
      Gets the inner com.azure.resourcemanager.cognitiveservices.fluent.models.AccountInner object.
      Returns:
      the inner object.

    • update

      Account.Update update()
      Begins update for the Account resource.
      Returns:
      the stage of resource update.

    • refresh

      Account refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      Account 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.

    • listKeys

      ApiKeys listKeys()
      Lists the account keys for the specified Cognitive Services account.
      Returns:
      the access keys for the cognitive services account.
      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.

    • listKeysWithResponse

      com.azure.core.http.rest.Response<ApiKeys> listKeysWithResponse(com.azure.core.util.Context context)
      Lists the account keys for the specified Cognitive Services account.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the access keys for the cognitive services account along with 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.

    • regenerateKey

      ApiKeys regenerateKey(RegenerateKeyParameters parameters)
      Regenerates the specified account key for the specified Cognitive Services account.
      Parameters:
      parameters - regenerate key parameters.
      Returns:
      the access keys for the cognitive services account.
      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.

    • regenerateKeyWithResponse

      com.azure.core.http.rest.Response<ApiKeys> regenerateKeyWithResponse(RegenerateKeyParameters parameters, com.azure.core.util.Context context)
      Regenerates the specified account key for the specified Cognitive Services account.
      Parameters:
      parameters - regenerate key parameters.
      context - The context to associate with this operation.
      Returns:
      the access keys for the cognitive services account along with 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.