Interface Relationships
public interface Relationships
Resource collection API of Relationships.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new RelationshipResourceFormat resource.void
Deletes a relationship within a hub.void
delete
(String resourceGroupName, String hubName, String relationshipName, com.azure.core.util.Context context) Deletes a relationship within a hub.void
deleteById
(String id) Deletes a relationship within a hub.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes a relationship within a hub.Gets information about the specified relationship.Gets information about the specified relationship.com.azure.core.http.rest.Response<RelationshipResourceFormat>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets information about the specified relationship.com.azure.core.http.rest.Response<RelationshipResourceFormat>
getWithResponse
(String resourceGroupName, String hubName, String relationshipName, com.azure.core.util.Context context) Gets information about the specified relationship.com.azure.core.http.rest.PagedIterable<RelationshipResourceFormat>
Gets all relationships in the hub.com.azure.core.http.rest.PagedIterable<RelationshipResourceFormat>
Gets all relationships in the hub.
-
Method Details
-
getWithResponse
com.azure.core.http.rest.Response<RelationshipResourceFormat> getWithResponse(String resourceGroupName, String hubName, String relationshipName, com.azure.core.util.Context context) Gets information about the specified relationship.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.relationshipName
- The name of the relationship.context
- The context to associate with this operation.- Returns:
- information about the specified relationship 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.
-
get
Gets information about the specified relationship.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.relationshipName
- The name of the relationship.- Returns:
- information about the specified relationship.
- 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
Deletes a relationship within a hub.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.relationshipName
- The name of the relationship.- 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 hubName, String relationshipName, com.azure.core.util.Context context) Deletes a relationship within a hub.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.relationshipName
- The name of the relationship.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.
-
listByHub
com.azure.core.http.rest.PagedIterable<RelationshipResourceFormat> listByHub(String resourceGroupName, String hubName) Gets all relationships in the hub.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.- Returns:
- all relationships in the hub 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.
-
listByHub
com.azure.core.http.rest.PagedIterable<RelationshipResourceFormat> listByHub(String resourceGroupName, String hubName, com.azure.core.util.Context context) Gets all relationships in the hub.- Parameters:
resourceGroupName
- The name of the resource group.hubName
- The name of the hub.context
- The context to associate with this operation.- Returns:
- all relationships in the hub 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.
-
getById
Gets information about the specified relationship.- Parameters:
id
- the resource ID.- Returns:
- information about the specified relationship 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<RelationshipResourceFormat> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets information about the specified relationship.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- information about the specified relationship 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.
-
deleteById
Deletes a relationship within a hub.- 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
Deletes a relationship within a hub.- 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
Begins definition for a new RelationshipResourceFormat resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new RelationshipResourceFormat definition.
-