Package com.azure.resourcemanager.apimanagement.models

Interface NamedValues

public interface NamedValues

Resource collection API of NamedValues.

Method Summary

Modifier and Type	Method	Description
NamedValueContract.DefinitionStages.Blank	define(String name)	Begins definition for a new NamedValueContract resource.
void	delete(String resourceGroupName, String serviceName, String namedValueId, String ifMatch)	Deletes specific named value from the API Management service instance.
void	deleteById(String id)	Deletes specific named value from the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)	Deletes specific named value from the API Management service instance.
com.azure.core.http.rest.Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String namedValueId, String ifMatch, com.azure.core.util.Context context)	Deletes specific named value from the API Management service instance.
NamedValueContract	get(String resourceGroupName, String serviceName, String namedValueId)	Gets the details of the named value specified by its identifier.
NamedValueContract	getById(String id)	Gets the details of the named value specified by its identifier.
com.azure.core.http.rest.Response<NamedValueContract>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Gets the details of the named value specified by its identifier.
void	getEntityTag(String resourceGroupName, String serviceName, String namedValueId)	Gets the entity state (Etag) version of the named value specified by its identifier.
NamedValuesGetEntityTagResponse	getEntityTagWithResponse(String resourceGroupName, String serviceName, String namedValueId, com.azure.core.util.Context context)	Gets the entity state (Etag) version of the named value specified by its identifier.
com.azure.core.http.rest.Response<NamedValueContract>	getWithResponse(String resourceGroupName, String serviceName, String namedValueId, com.azure.core.util.Context context)	Gets the details of the named value specified by its identifier.
com.azure.core.http.rest.PagedIterable<NamedValueContract>	listByService(String resourceGroupName, String serviceName)	Lists a collection of named values defined within a service instance.
com.azure.core.http.rest.PagedIterable<NamedValueContract>	listByService(String resourceGroupName, String serviceName, String filter, Integer top, Integer skip, Boolean isKeyVaultRefreshFailed, com.azure.core.util.Context context)	Lists a collection of named values defined within a service instance.
NamedValueSecretContract	listValue(String resourceGroupName, String serviceName, String namedValueId)	Gets the secret of the named value specified by its identifier.
com.azure.core.http.rest.Response<NamedValueSecretContract>	listValueWithResponse(String resourceGroupName, String serviceName, String namedValueId, com.azure.core.util.Context context)	Gets the secret of the named value specified by its identifier.
NamedValueContract	refreshSecret(String resourceGroupName, String serviceName, String namedValueId)	Refresh the secret of the named value specified by its identifier.
NamedValueContract	refreshSecret(String resourceGroupName, String serviceName, String namedValueId, com.azure.core.util.Context context)	Refresh the secret of the named value specified by its identifier.

Method Detail

listByService

com.azure.core.http.rest.PagedIterable<NamedValueContract> listByService(String resourceGroupName,
                                                                         String serviceName)

Lists a collection of named values defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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 filter,
                                                                         Integer top,
                                                                         Integer skip,
                                                                         Boolean isKeyVaultRefreshFailed,
                                                                         com.azure.core.util.Context context)

Lists a collection of named values defined within a service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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 - When set to true, the response contains only named value entities which failed refresh.

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.

getEntityTag

void getEntityTag(String resourceGroupName,
                  String serviceName,
                  String namedValueId)

Gets the entity state (Etag) version of the named value specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

getEntityTagWithResponse

NamedValuesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName,
                                                         String serviceName,
                                                         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.

serviceName - The name of the API Management service.

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.

get

NamedValueContract get(String resourceGroupName,
                       String serviceName,
                       String namedValueId)

Gets the details of the named value specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

getWithResponse

com.azure.core.http.rest.Response<NamedValueContract> getWithResponse(String resourceGroupName,
                                                                      String serviceName,
                                                                      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.

serviceName - The name of the API Management service.

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.

delete

void delete(String resourceGroupName,
            String serviceName,
            String namedValueId,
            String ifMatch)

Deletes specific named value from the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

deleteWithResponse

com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName,
                                                           String serviceName,
                                                           String namedValueId,
                                                           String ifMatch,
                                                           com.azure.core.util.Context context)

Deletes specific named value from the API Management service instance.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

listValue

NamedValueSecretContract listValue(String resourceGroupName,
                                   String serviceName,
                                   String namedValueId)

Gets the secret of the named value specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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.

listValueWithResponse

com.azure.core.http.rest.Response<NamedValueSecretContract> listValueWithResponse(String resourceGroupName,
                                                                                  String serviceName,
                                                                                  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.

serviceName - The name of the API Management service.

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.

refreshSecret

NamedValueContract refreshSecret(String resourceGroupName,
                                 String serviceName,
                                 String namedValueId)

Refresh the secret of the named value specified by its identifier.

Parameters:

resourceGroupName - The name of the resource group.

serviceName - The name of the API Management service.

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

serviceName - The name of the API Management service.

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.

getById

NamedValueContract getById(String id)

Gets the details of the named value specified by its identifier.

Parameters:

id - the resource ID.

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.

getByIdWithResponse

com.azure.core.http.rest.Response<NamedValueContract> getByIdWithResponse(String id,
                                                                          com.azure.core.util.Context context)

Gets the details of the named value specified by its identifier.

Parameters:

id - the resource ID.

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.

deleteById

void deleteById(String id)

Deletes specific named value from the API Management service instance.

Parameters:

id - the resource ID.

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.

deleteByIdWithResponse

com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id,
                                                               String ifMatch,
                                                               com.azure.core.util.Context context)

Deletes specific named value from the API Management service instance.

Parameters:

id - the resource ID.

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.

define

NamedValueContract.DefinitionStages.Blank define(String name)

Begins definition for a new NamedValueContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new NamedValueContract definition.