Package com.azure.resourcemanager.apimanagement.models

Interface WorkspaceNamedValues

public interface WorkspaceNamedValues
Resource collection API of WorkspaceNamedValues.

  • Method Details

    • listByService

      com.azure.core.http.rest.PagedIterable<NamedValueContract> listByService(String resourceGroupName, String serviceName, String workspaceId)
      Lists a collection of named values defined within a workspace in a service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      Returns:
      paged NamedValue list representation as paginated response with PagedIterable.
      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.

    • listByService

      com.azure.core.http.rest.PagedIterable<NamedValueContract> listByService(String resourceGroupName, String serviceName, String workspaceId, String filter, Integer top, Integer skip, KeyVaultRefreshState isKeyVaultRefreshFailed, com.azure.core.util.Context context)
      Lists a collection of named values defined within a workspace in a service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.
      top - Number of records to return.
      skip - Number of records to skip.
      isKeyVaultRefreshFailed - Query parameter to fetch named value entities based on refresh status.
      context - The context to associate with this operation.
      Returns:
      paged NamedValue list representation as paginated response with PagedIterable.
      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.

    • getEntityTagWithResponse

      WorkspaceNamedValuesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the named value specified by its identifier.
      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.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String workspaceId, String namedValueId)
      Gets the entity state (Etag) version of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      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.

    • getWithResponse

      com.azure.core.http.rest.Response<NamedValueContract> getWithResponse(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, com.azure.core.util.Context context)
      Gets the details of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      context - The context to associate with this operation.
      Returns:
      the details of the named value specified by its identifier.
      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.

    • get

      NamedValueContract get(String resourceGroupName, String serviceName, String workspaceId, String namedValueId)
      Gets the details of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      Returns:
      the details of the named value specified by its identifier.
      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.

    • createOrUpdate

      NamedValueContract createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, NamedValueCreateContract parameters)
      Creates or updates named value.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      parameters - Create parameters.
      Returns:
      namedValue 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.

    • createOrUpdate

      NamedValueContract createOrUpdate(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, NamedValueCreateContract parameters, String ifMatch, com.azure.core.util.Context context)
      Creates or updates named value.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      parameters - Create parameters.
      ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      context - The context to associate with this operation.
      Returns:
      namedValue 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.

    • update

      NamedValueContract update(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, String ifMatch, NamedValueUpdateParameters parameters)
      Updates the specific named value.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      parameters - Update parameters.
      Returns:
      namedValue 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.

    • update

      NamedValueContract update(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, String ifMatch, NamedValueUpdateParameters parameters, com.azure.core.util.Context context)
      Updates the specific named value.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      parameters - Update parameters.
      context - The context to associate with this operation.
      Returns:
      namedValue 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.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, String ifMatch, com.azure.core.util.Context context)
      Deletes specific named value from the workspace in an API Management service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      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.

    • delete

      void delete(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, String ifMatch)
      Deletes specific named value from the workspace in an API Management service instance.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      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.

    • listValueWithResponse

      com.azure.core.http.rest.Response<NamedValueSecretContract> listValueWithResponse(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, com.azure.core.util.Context context)
      Gets the secret of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      context - The context to associate with this operation.
      Returns:
      the secret of the named value specified by its identifier.
      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.

    • listValue

      NamedValueSecretContract listValue(String resourceGroupName, String serviceName, String workspaceId, String namedValueId)
      Gets the secret of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      Returns:
      the secret of the named value specified by its identifier.
      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.

    • refreshSecret

      NamedValueContract refreshSecret(String resourceGroupName, String serviceName, String workspaceId, String namedValueId)
      Refresh the secret of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      Returns:
      namedValue 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.

    • refreshSecret

      NamedValueContract refreshSecret(String resourceGroupName, String serviceName, String workspaceId, String namedValueId, com.azure.core.util.Context context)
      Refresh the secret of the named value specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      workspaceId - Workspace identifier. Must be unique in the current API Management service instance.
      namedValueId - Identifier of the NamedValue.
      context - The context to associate with this operation.
      Returns:
      namedValue 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.