Package com.azure.resourcemanager.deviceprovisioningservices.models

Interface IotDpsResources

  • public interface IotDpsResources
    Resource collection API of IotDpsResources.

    • Method Detail

      • getByResourceGroup

        ProvisioningServiceDescription getByResourceGroup​(String resourceGroupName,
                                                  String provisioningServiceName)
        Get the metadata of the provisioning service without SAS keys.
        Parameters:
        resourceGroupName - Resource group name.
        provisioningServiceName - Name of the provisioning service to retrieve.
        Returns:
        the metadata of the provisioning service without SAS keys.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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<ProvisioningServiceDescription> getByResourceGroupWithResponse​(String resourceGroupName,
                                                                                                 String provisioningServiceName,
                                                                                                 com.azure.core.util.Context context)
        Get the metadata of the provisioning service without SAS keys.
        Parameters:
        resourceGroupName - Resource group name.
        provisioningServiceName - Name of the provisioning service to retrieve.
        context - The context to associate with this operation.
        Returns:
        the metadata of the provisioning service without SAS keys along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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 provisioningServiceName)
        Deletes the Provisioning Service.
        Parameters:
        resourceGroupName - Resource group identifier.
        provisioningServiceName - Name of provisioning service to delete.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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 provisioningServiceName,
            com.azure.core.util.Context context)
        Deletes the Provisioning Service.
        Parameters:
        resourceGroupName - Resource group identifier.
        provisioningServiceName - Name of provisioning service to delete.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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<ProvisioningServiceDescription> list()
        List all the provisioning services for a given subscription id.
        Returns:
        list of provisioning service descriptions.
        Throws:
        ErrorDetailsException - 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<ProvisioningServiceDescription> list​(com.azure.core.util.Context context)
        List all the provisioning services for a given subscription id.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        list of provisioning service descriptions.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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<ProvisioningServiceDescription> listByResourceGroup​(String resourceGroupName)
        Get a list of all provisioning services in the given resource group.
        Parameters:
        resourceGroupName - Resource group identifier.
        Returns:
        a list of all provisioning services in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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<ProvisioningServiceDescription> listByResourceGroup​(String resourceGroupName,
                                                                                           com.azure.core.util.Context context)
        Get a list of all provisioning services in the given resource group.
        Parameters:
        resourceGroupName - Resource group identifier.
        context - The context to associate with this operation.
        Returns:
        a list of all provisioning services in the given resource group.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getOperationResult

        AsyncOperationResult getOperationResult​(String operationId,
                                        String resourceGroupName,
                                        String provisioningServiceName,
                                        String asyncinfo)
        Gets the status of a long running operation, such as create, update or delete a provisioning service.
        Parameters:
        operationId - Operation id corresponding to long running operation. Use this to poll for the status.
        resourceGroupName - Resource group identifier.
        provisioningServiceName - Name of provisioning service that the operation is running on.
        asyncinfo - Async header used to poll on the status of the operation, obtained while creating the long running operation.
        Returns:
        the status of a long running operation, such as create, update or delete a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getOperationResultWithResponse

        com.azure.core.http.rest.Response<AsyncOperationResult> getOperationResultWithResponse​(String operationId,
                                                                                       String resourceGroupName,
                                                                                       String provisioningServiceName,
                                                                                       String asyncinfo,
                                                                                       com.azure.core.util.Context context)
        Gets the status of a long running operation, such as create, update or delete a provisioning service.
        Parameters:
        operationId - Operation id corresponding to long running operation. Use this to poll for the status.
        resourceGroupName - Resource group identifier.
        provisioningServiceName - Name of provisioning service that the operation is running on.
        asyncinfo - Async header used to poll on the status of the operation, obtained while creating the long running operation.
        context - The context to associate with this operation.
        Returns:
        the status of a long running operation, such as create, update or delete a provisioning service along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listValidSkus

        com.azure.core.http.rest.PagedIterable<IotDpsSkuDefinition> listValidSkus​(String provisioningServiceName,
                                                                          String resourceGroupName)
        Gets the list of valid SKUs and tiers for a provisioning service.
        Parameters:
        provisioningServiceName - Name of provisioning service.
        resourceGroupName - Name of resource group.
        Returns:
        the list of valid SKUs and tiers for a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listValidSkus

        com.azure.core.http.rest.PagedIterable<IotDpsSkuDefinition> listValidSkus​(String provisioningServiceName,
                                                                          String resourceGroupName,
                                                                          com.azure.core.util.Context context)
        Gets the list of valid SKUs and tiers for a provisioning service.
        Parameters:
        provisioningServiceName - Name of provisioning service.
        resourceGroupName - Name of resource group.
        context - The context to associate with this operation.
        Returns:
        the list of valid SKUs and tiers for a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • checkProvisioningServiceNameAvailability

        NameAvailabilityInfo checkProvisioningServiceNameAvailability​(OperationInputs arguments)
        Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable.
        Parameters:
        arguments - Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.
        Returns:
        description of name availability.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • checkProvisioningServiceNameAvailabilityWithResponse

        com.azure.core.http.rest.Response<NameAvailabilityInfo> checkProvisioningServiceNameAvailabilityWithResponse​(OperationInputs arguments,
                                                                                                             com.azure.core.util.Context context)
        Check if a provisioning service name is available. This will validate if the name is syntactically valid and if the name is usable.
        Parameters:
        arguments - Set the name parameter in the OperationInputs structure to the name of the provisioning service to check.
        context - The context to associate with this operation.
        Returns:
        description of name availability along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeys

        com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys​(String provisioningServiceName,
                                                                                        String resourceGroupName)
        List the primary and secondary keys for a provisioning service.
        Parameters:
        provisioningServiceName - The provisioning service name to get the shared access keys for.
        resourceGroupName - resource group name.
        Returns:
        list of shared access keys.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeys

        com.azure.core.http.rest.PagedIterable<SharedAccessSignatureAuthorizationRule> listKeys​(String provisioningServiceName,
                                                                                        String resourceGroupName,
                                                                                        com.azure.core.util.Context context)
        List the primary and secondary keys for a provisioning service.
        Parameters:
        provisioningServiceName - The provisioning service name to get the shared access keys for.
        resourceGroupName - resource group name.
        context - The context to associate with this operation.
        Returns:
        list of shared access keys.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeysForKeyName

        SharedAccessSignatureAuthorizationRule listKeysForKeyName​(String provisioningServiceName,
                                                          String keyName,
                                                          String resourceGroupName)
        List primary and secondary keys for a specific key name.
        Parameters:
        provisioningServiceName - Name of the provisioning service.
        keyName - Logical key name to get key-values for.
        resourceGroupName - The name of the resource group that contains the provisioning service.
        Returns:
        description of the shared access key.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listKeysForKeyNameWithResponse

        com.azure.core.http.rest.Response<SharedAccessSignatureAuthorizationRule> listKeysForKeyNameWithResponse​(String provisioningServiceName,
                                                                                                         String keyName,
                                                                                                         String resourceGroupName,
                                                                                                         com.azure.core.util.Context context)
        List primary and secondary keys for a specific key name.
        Parameters:
        provisioningServiceName - Name of the provisioning service.
        keyName - Logical key name to get key-values for.
        resourceGroupName - The name of the resource group that contains the provisioning service.
        context - The context to associate with this operation.
        Returns:
        description of the shared access key along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listPrivateLinkResources

        PrivateLinkResources listPrivateLinkResources​(String resourceGroupName,
                                              String resourceName)
        List private link resources for the given provisioning service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        Returns:
        the available private link resources for a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listPrivateLinkResourcesWithResponse

        com.azure.core.http.rest.Response<PrivateLinkResources> listPrivateLinkResourcesWithResponse​(String resourceGroupName,
                                                                                             String resourceName,
                                                                                             com.azure.core.util.Context context)
        List private link resources for the given provisioning service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        context - The context to associate with this operation.
        Returns:
        the available private link resources for a provisioning service along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getPrivateLinkResources

        GroupIdInformation getPrivateLinkResources​(String resourceGroupName,
                                           String resourceName,
                                           String groupId)
        Get the specified private link resource for the given provisioning service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        groupId - The name of the private link resource.
        Returns:
        the specified private link resource for the given provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getPrivateLinkResourcesWithResponse

        com.azure.core.http.rest.Response<GroupIdInformation> getPrivateLinkResourcesWithResponse​(String resourceGroupName,
                                                                                          String resourceName,
                                                                                          String groupId,
                                                                                          com.azure.core.util.Context context)
        Get the specified private link resource for the given provisioning service.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        groupId - The name of the private link resource.
        context - The context to associate with this operation.
        Returns:
        the specified private link resource for the given provisioning service along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listPrivateEndpointConnections

        List<PrivateEndpointConnection> listPrivateEndpointConnections​(String resourceGroupName,
                                                               String resourceName)
        List private endpoint connection properties.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        Returns:
        the list of private endpoint connections for a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • listPrivateEndpointConnectionsWithResponse

        com.azure.core.http.rest.Response<List<PrivateEndpointConnection>> listPrivateEndpointConnectionsWithResponse​(String resourceGroupName,
                                                                                                              String resourceName,
                                                                                                              com.azure.core.util.Context context)
        List private endpoint connection properties.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        context - The context to associate with this operation.
        Returns:
        the list of private endpoint connections for a provisioning service along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getPrivateEndpointConnection

        PrivateEndpointConnection getPrivateEndpointConnection​(String resourceGroupName,
                                                       String resourceName,
                                                       String privateEndpointConnectionName)
        Get private endpoint connection properties.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        private endpoint connection properties.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getPrivateEndpointConnectionWithResponse

        com.azure.core.http.rest.Response<PrivateEndpointConnection> getPrivateEndpointConnectionWithResponse​(String resourceGroupName,
                                                                                                      String resourceName,
                                                                                                      String privateEndpointConnectionName,
                                                                                                      com.azure.core.util.Context context)
        Get private endpoint connection properties.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        privateEndpointConnectionName - The name of the private endpoint connection.
        context - The context to associate with this operation.
        Returns:
        private endpoint connection properties along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deletePrivateEndpointConnection

        PrivateEndpointConnection deletePrivateEndpointConnection​(String resourceGroupName,
                                                          String resourceName,
                                                          String privateEndpointConnectionName)
        Delete private endpoint connection with the specified name.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        privateEndpointConnectionName - The name of the private endpoint connection.
        Returns:
        the private endpoint connection of a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deletePrivateEndpointConnection

        PrivateEndpointConnection deletePrivateEndpointConnection​(String resourceGroupName,
                                                          String resourceName,
                                                          String privateEndpointConnectionName,
                                                          com.azure.core.util.Context context)
        Delete private endpoint connection with the specified name.
        Parameters:
        resourceGroupName - The name of the resource group that contains the provisioning service.
        resourceName - The name of the provisioning service.
        privateEndpointConnectionName - The name of the private endpoint connection.
        context - The context to associate with this operation.
        Returns:
        the private endpoint connection of a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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<ProvisioningServiceDescription> getByIdWithResponse​(String id,
                                                                                      com.azure.core.util.Context context)
        Get the metadata of the provisioning service without SAS keys.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the metadata of the provisioning service without SAS keys along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getPrivateEndpointConnectionById

        PrivateEndpointConnection getPrivateEndpointConnectionById​(String id)
        Get private endpoint connection properties.
        Parameters:
        id - the resource ID.
        Returns:
        private endpoint connection properties along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getPrivateEndpointConnectionByIdWithResponse

        com.azure.core.http.rest.Response<PrivateEndpointConnection> getPrivateEndpointConnectionByIdWithResponse​(String id,
                                                                                                          com.azure.core.util.Context context)
        Get private endpoint connection properties.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        private endpoint connection properties along with Response.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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 the Provisioning Service.
        Parameters:
        id - the resource ID.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - 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)
        Deletes the Provisioning Service.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deletePrivateEndpointConnectionById

        PrivateEndpointConnection deletePrivateEndpointConnectionById​(String id)
        Delete private endpoint connection with the specified name.
        Parameters:
        id - the resource ID.
        Returns:
        the private endpoint connection of a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • deletePrivateEndpointConnectionByIdWithResponse

        PrivateEndpointConnection deletePrivateEndpointConnectionByIdWithResponse​(String id,
                                                                          com.azure.core.util.Context context)
        Delete private endpoint connection with the specified name.
        Parameters:
        id - the resource ID.
        context - The context to associate with this operation.
        Returns:
        the private endpoint connection of a provisioning service.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        ErrorDetailsException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • definePrivateEndpointConnection

        PrivateEndpointConnection.DefinitionStages.Blank definePrivateEndpointConnection​(String name)
        Begins definition for a new PrivateEndpointConnection resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new PrivateEndpointConnection definition.