Package com.azure.resourcemanager.confluent.models

Interface Organizations

public interface Organizations

Resource collection API of Organizations.

Method Summary

Modifier and Type	Method	Description
OrganizationResource.DefinitionStages.Blank	define(String name)	Begins definition for a new OrganizationResource resource.
void	delete(String resourceGroupName, String organizationName, com.azure.core.util.Context context)	Delete Organization resource.
void	deleteById(String id)	Delete Organization resource.
void	deleteByIdWithResponse(String id, com.azure.core.util.Context context)	Delete Organization resource.
void	deleteByResourceGroup(String resourceGroupName, String organizationName)	Delete Organization resource.
OrganizationResource	getById(String id)	Get the properties of a specific Organization resource.
com.azure.core.http.rest.Response<OrganizationResource>	getByIdWithResponse(String id, com.azure.core.util.Context context)	Get the properties of a specific Organization resource.
OrganizationResource	getByResourceGroup(String resourceGroupName, String organizationName)	Get the properties of a specific Organization resource.
com.azure.core.http.rest.Response<OrganizationResource>	getByResourceGroupWithResponse(String resourceGroupName, String organizationName, com.azure.core.util.Context context)	Get the properties of a specific Organization resource.
com.azure.core.http.rest.PagedIterable<OrganizationResource>	list()	List all organizations under the specified subscription.
com.azure.core.http.rest.PagedIterable<OrganizationResource>	list(com.azure.core.util.Context context)	List all organizations under the specified subscription.
com.azure.core.http.rest.PagedIterable<OrganizationResource>	listByResourceGroup(String resourceGroupName)	List all Organizations under the specified resource group.
com.azure.core.http.rest.PagedIterable<OrganizationResource>	listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context)	List all Organizations under the specified resource group.

Method Detail

list

com.azure.core.http.rest.PagedIterable<OrganizationResource> list()

List all organizations under the specified subscription.

Returns:

the response of a list operation.

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.

list

com.azure.core.http.rest.PagedIterable<OrganizationResource> list(com.azure.core.util.Context context)

List all organizations under the specified subscription.

Parameters:

context - The context to associate with this operation.

Returns:

the response of a list operation.

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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<OrganizationResource> listByResourceGroup(String resourceGroupName)

List all Organizations under the specified resource group.

Parameters:

resourceGroupName - Resource group name.

Returns:

the response of a list operation.

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.

listByResourceGroup

com.azure.core.http.rest.PagedIterable<OrganizationResource> listByResourceGroup(String resourceGroupName,
                                                                                 com.azure.core.util.Context context)

List all Organizations under the specified resource group.

Parameters:

resourceGroupName - Resource group name.

context - The context to associate with this operation.

Returns:

the response of a list operation.

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.

getByResourceGroup

OrganizationResource getByResourceGroup(String resourceGroupName,
                                        String organizationName)

Get the properties of a specific Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

Returns:

the properties of a specific Organization resource.

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.

getByResourceGroupWithResponse

com.azure.core.http.rest.Response<OrganizationResource> getByResourceGroupWithResponse(String resourceGroupName,
                                                                                       String organizationName,
                                                                                       com.azure.core.util.Context context)

Get the properties of a specific Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

context - The context to associate with this operation.

Returns:

the properties of a specific Organization resource.

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.

deleteByResourceGroup

void deleteByResourceGroup(String resourceGroupName,
                           String organizationName)

Delete Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

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 organizationName,
            com.azure.core.util.Context context)

Delete Organization resource.

Parameters:

resourceGroupName - Resource group name.

organizationName - Organization resource name.

context - The context to associate with this operation.

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

OrganizationResource getById(String id)

Get the properties of a specific Organization resource.

Parameters:

id - the resource ID.

Returns:

the properties of a specific Organization resource.

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<OrganizationResource> getByIdWithResponse(String id,
                                                                            com.azure.core.util.Context context)

Get the properties of a specific Organization resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the properties of a specific Organization resource.

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)

Delete Organization resource.

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

void deleteByIdWithResponse(String id,
                            com.azure.core.util.Context context)

Delete Organization resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

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

OrganizationResource.DefinitionStages.Blank define(String name)

Begins definition for a new OrganizationResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new OrganizationResource definition.