PartnerNamespaces Interface

Package:

com.azure.resourcemanager.eventgrid.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-eventgrid:1.3.0-beta.1

public interface PartnerNamespaces

Resource collection API of PartnerNamespaces.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new PartnerNamespace resource.
abstract void	delete(String resourceGroupName, String partnerNamespaceName, Context context) Delete a partner namespace.
abstract void	deleteById(String id) Delete a partner namespace.
abstract void	deleteByIdWithResponse(String id, Context context) Delete a partner namespace.
abstract void	deleteByResourceGroup(String resourceGroupName, String partnerNamespaceName) Delete a partner namespace.
abstract PartnerNamespace	getById(String id) Get a partner namespace.
abstract Response<PartnerNamespace>	getByIdWithResponse(String id, Context context) Get a partner namespace.
abstract PartnerNamespace	getByResourceGroup(String resourceGroupName, String partnerNamespaceName) Get a partner namespace.
abstract Response<PartnerNamespace>	getByResourceGroupWithResponse(String resourceGroupName, String partnerNamespaceName, Context context) Get a partner namespace.
abstract PagedIterable<PartnerNamespace>	list() List partner namespaces under an Azure subscription.
abstract PagedIterable<PartnerNamespace>	list(String filter, Integer top, Context context) List partner namespaces under an Azure subscription.
abstract PagedIterable<PartnerNamespace>	listByResourceGroup(String resourceGroupName) List partner namespaces under a resource group.
abstract PagedIterable<PartnerNamespace>	listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context) List partner namespaces under a resource group.
abstract PartnerNamespaceSharedAccessKeys	listSharedAccessKeys(String resourceGroupName, String partnerNamespaceName) List keys for a partner namespace.
abstract Response<PartnerNamespaceSharedAccessKeys>	listSharedAccessKeysWithResponse(String resourceGroupName, String partnerNamespaceName, Context context) List keys for a partner namespace.
abstract PartnerNamespaceSharedAccessKeys	regenerateKey(String resourceGroupName, String partnerNamespaceName, PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest) Regenerate key for a partner namespace.
abstract Response<PartnerNamespaceSharedAccessKeys>	regenerateKeyWithResponse(String resourceGroupName, String partnerNamespaceName, PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest, Context context) Regenerate key for a partner namespace.

Method Details

define

public abstract PartnerNamespace.DefinitionStages.Blank define(String name)

Begins definition for a new PartnerNamespace resource.

Parameters:

name - resource name.

Returns:

the first stage of the new PartnerNamespace definition.

delete

public abstract void delete(String resourceGroupName, String partnerNamespaceName, Context context)

Delete a partner namespace. Delete existing partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete a partner namespace. Delete existing partner namespace.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete a partner namespace. Delete existing partner namespace.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract void deleteByResourceGroup(String resourceGroupName, String partnerNamespaceName)

Delete a partner namespace. Delete existing partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

getById

public abstract PartnerNamespace getById(String id)

Get a partner namespace. Get properties of a partner namespace.

Parameters:

id - the resource ID.

Returns:

properties of a partner namespace along with Response<T>.

getByIdWithResponse

public abstract Response<PartnerNamespace> getByIdWithResponse(String id, Context context)

Get a partner namespace. Get properties of a partner namespace.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

properties of a partner namespace along with Response<T>.

getByResourceGroup

public abstract PartnerNamespace getByResourceGroup(String resourceGroupName, String partnerNamespaceName)

Get a partner namespace. Get properties of a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

Returns:

properties of a partner namespace.

getByResourceGroupWithResponse

public abstract Response<PartnerNamespace> getByResourceGroupWithResponse(String resourceGroupName, String partnerNamespaceName, Context context)

Get a partner namespace. Get properties of a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

context - The context to associate with this operation.

Returns:

properties of a partner namespace along with Response<T>.

list

public abstract PagedIterable<PartnerNamespace> list()

List partner namespaces under an Azure subscription. List all the partner namespaces under an Azure subscription.

Returns:

result of the List Partner Namespaces operation as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<PartnerNamespace> list(String filter, Integer top, Context context)

List partner namespaces under an Azure subscription. List all the partner namespaces under an Azure subscription.

Parameters:

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List Partner Namespaces operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<PartnerNamespace> listByResourceGroup(String resourceGroupName)

List partner namespaces under a resource group. List all the partner namespaces under a resource group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

Returns:

result of the List Partner Namespaces operation as paginated response with PagedIterable<T>.

listByResourceGroup

public abstract PagedIterable<PartnerNamespace> listByResourceGroup(String resourceGroupName, String filter, Integer top, Context context)

List partner namespaces under a resource group. List all the partner namespaces under a resource group.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

filter - The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

top - The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

context - The context to associate with this operation.

Returns:

result of the List Partner Namespaces operation as paginated response with PagedIterable<T>.

listSharedAccessKeys

public abstract PartnerNamespaceSharedAccessKeys listSharedAccessKeys(String resourceGroupName, String partnerNamespaceName)

List keys for a partner namespace. List the two keys used to publish to a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

Returns:

shared access keys of the partner namespace.

listSharedAccessKeysWithResponse

public abstract Response<PartnerNamespaceSharedAccessKeys> listSharedAccessKeysWithResponse(String resourceGroupName, String partnerNamespaceName, Context context)

List keys for a partner namespace. List the two keys used to publish to a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

context - The context to associate with this operation.

Returns:

shared access keys of the partner namespace along with Response<T>.

regenerateKey

public abstract PartnerNamespaceSharedAccessKeys regenerateKey(String resourceGroupName, String partnerNamespaceName, PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest)

Regenerate key for a partner namespace. Regenerate a shared access key for a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

regenerateKeyRequest - Request body to regenerate key.

Returns:

shared access keys of the partner namespace.

regenerateKeyWithResponse

public abstract Response<PartnerNamespaceSharedAccessKeys> regenerateKeyWithResponse(String resourceGroupName, String partnerNamespaceName, PartnerNamespaceRegenerateKeyRequest regenerateKeyRequest, Context context)

Regenerate key for a partner namespace. Regenerate a shared access key for a partner namespace.

Parameters:

resourceGroupName - The name of the resource group within the user's subscription.

partnerNamespaceName - Name of the partner namespace.

regenerateKeyRequest - Request body to regenerate key.

context - The context to associate with this operation.

Returns:

shared access keys of the partner namespace along with Response<T>.