Interface Credentials
public interface Credentials
Resource collection API of Credentials.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new Credential resource.void
Delete the credential.void
deleteById
(String id) Delete the credential.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Delete the credential.com.azure.core.http.rest.Response<Void>
deleteWithResponse
(String resourceGroupName, String automationAccountName, String credentialName, com.azure.core.util.Context context) Delete the credential.Retrieve the credential identified by credential name.Retrieve the credential identified by credential name.com.azure.core.http.rest.Response<Credential>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Retrieve the credential identified by credential name.com.azure.core.http.rest.Response<Credential>
getWithResponse
(String resourceGroupName, String automationAccountName, String credentialName, com.azure.core.util.Context context) Retrieve the credential identified by credential name.com.azure.core.http.rest.PagedIterable<Credential>
listByAutomationAccount
(String resourceGroupName, String automationAccountName) Retrieve a list of credentials.com.azure.core.http.rest.PagedIterable<Credential>
listByAutomationAccount
(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context) Retrieve a list of credentials.
-
Method Details
-
delete
Delete the credential.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.credentialName
- The name of credential.- 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 automationAccountName, String credentialName, com.azure.core.util.Context context) Delete the credential.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.credentialName
- The name of credential.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.
-
get
Retrieve the credential identified by credential name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.credentialName
- The name of credential.- Returns:
- definition of the credential.
- 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<Credential> getWithResponse(String resourceGroupName, String automationAccountName, String credentialName, com.azure.core.util.Context context) Retrieve the credential identified by credential name.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.credentialName
- The name of credential.context
- The context to associate with this operation.- Returns:
- definition of the credential 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.
-
listByAutomationAccount
com.azure.core.http.rest.PagedIterable<Credential> listByAutomationAccount(String resourceGroupName, String automationAccountName) Retrieve a list of credentials.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.- Returns:
- the response model for the list credential operation 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.
-
listByAutomationAccount
com.azure.core.http.rest.PagedIterable<Credential> listByAutomationAccount(String resourceGroupName, String automationAccountName, com.azure.core.util.Context context) Retrieve a list of credentials.- Parameters:
resourceGroupName
- Name of an Azure Resource group.automationAccountName
- The name of the automation account.context
- The context to associate with this operation.- Returns:
- the response model for the list credential operation 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
Retrieve the credential identified by credential name.- Parameters:
id
- the resource ID.- Returns:
- definition of the credential 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<Credential> getByIdWithResponse(String id, com.azure.core.util.Context context) Retrieve the credential identified by credential name.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- definition of the credential 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
Delete the credential.- 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, com.azure.core.util.Context context) Delete the credential.- Parameters:
id
- the resource ID.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
Begins definition for a new Credential resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new Credential definition.
-