return prov status from sync_fields()

R/az_resource.R

@@ -8,7 +8,7 @@
 #' - `check()`: Check if this resource still exists.
 #' - `delete(..., confirm=TRUE, wait=FALSE)`: Delete this resource, after a confirmation check. Optionally wait for the delete to finish.
 #' - `update(...)`: Update this resource on the host.
-#' - `sync_fields()`: Update the fields in this object with information from the host.
+#' - `sync_fields()`: Update the fields in this object with information from the host. Returns the `properties$provisioningState` field, so you can query this programmatically to check if a resource has finished provisioning. Not all resource types require explicit provisioning, in which case this method will return NULL.
 #' - `set_api_version(api_version)`: Set the API version to use when interacting with the host. By default, use the latest API version available.
 #' - `do_operation(...)` Carry out an operation. See 'Operations' for more details.
 #'
@@ -18,9 +18,10 @@
 #' All of these initialization options have the following arguments in common.
 #' 1. `token`: An OAuth 2.0 token, as generated by [get_azure_token].
 #' 2. `subscription`: The subscription ID.
-#' 3. `resource_group`: The resource group.
+#' 3. `api_version`: Optionally, the API version to use when interacting with the host. By default, this is NULL in which case the latest API version will be used.
 #' 4. A set of _identifying arguments_:
-#'    - `id`: The full ID of the resource. This is a string of the form `"/subscriptions/{uuid}/resourceGroups/{resource-group-name}/provider/{resource-provider-name}/{resource-path}/{resource-name}"`.
+#'    - `resource_group`: The resource group containing the resource.
+#'    - `id`: The full ID of the resource. This is a string of the form `/subscriptions/{uuid}/resourceGroups/{resource-group-name}/provider/{resource-provider-name}/{resource-path}/{resource-name}`.
 #'    - `provider`: The provider of the resource, eg `Microsoft.Compute`.
 #'    - `path`: The path to the resource, eg `virtualMachines`.
 #'    - `type`: The combination of provider and path, eg `Microsoft.Compute/virtualMachines`.
@@ -36,7 +37,7 @@
 #' The `do_operation()` method allows you to carry out arbitrary operations on the resource. It takes the following arguments:
 #' - `op`: The operation in question, which will be appended to the URL path of the request.
 #' - `options`: A named list giving the URL query parameters.
-#' - `...`: Other named arguments passed to [call_azure_rm], and then to the appropriate call in httr. In particular, use `body` to supply the body of a request.
+#' - `...`: Other named arguments passed to [call_azure_rm], and then to the appropriate call in httr. In particular, use `body` to supply the body of a PUT, POST or PATCH request.
 #' - `http_verb`: The HTTP verb as a string, one of `GET`, `PUT`, `POST`, `DELETE`, `HEAD` or `PATCH`.
 #'
 #' Consult the Azure documentation for your resource to find out what operations are supported.
@@ -127,7 +128,7 @@ public=list(
     sync_fields=function()
     {
         self$initialize(self$token, self$subscription, id=self$id)
-        invisible(NULL)
+        self$properties$provisioningState
     },
 
     delete=function(..., options=list(), confirm=TRUE, wait=FALSE)

man/az_resource.Rd

@@ -18,7 +18,7 @@ Class representing a generic Azure resource.
 \item \code{check()}: Check if this resource still exists.
 \item \code{delete(..., confirm=TRUE, wait=FALSE)}: Delete this resource, after a confirmation check. Optionally wait for the delete to finish.
 \item \code{update(...)}: Update this resource on the host.
-\item \code{sync_fields()}: Update the fields in this object with information from the host.
+\item \code{sync_fields()}: Update the fields in this object with information from the host. Returns the \code{properties$provisioningState} field, so you can query this programmatically to check if a resource has finished provisioning. Not all resource types require explicit provisioning, in which case this method will return NULL.
 \item \code{set_api_version(api_version)}: Set the API version to use when interacting with the host. By default, use the latest API version available.
 \item \code{do_operation(...)} Carry out an operation. See 'Operations' for more details.
 }
@@ -32,10 +32,11 @@ All of these initialization options have the following arguments in common.
 \enumerate{
 \item \code{token}: An OAuth 2.0 token, as generated by \link{get_azure_token}.
 \item \code{subscription}: The subscription ID.
-\item \code{resource_group}: The resource group.
+\item \code{api_version}: Optionally, the API version to use when interacting with the host. By default, this is NULL in which case the latest API version will be used.
 \item A set of \emph{identifying arguments}:
 \itemize{
-\item \code{id}: The full ID of the resource. This is a string of the form \code{"/subscriptions/{uuid}/resourceGroups/{resource-group-name}/provider/{resource-provider-name}/{resource-path}/{resource-name}"}.
+\item \code{resource_group}: The resource group containing the resource.
+\item \code{id}: The full ID of the resource. This is a string of the form \code{/subscriptions/{uuid}/resourceGroups/{resource-group-name}/provider/{resource-provider-name}/{resource-path}/{resource-name}}.
 \item \code{provider}: The provider of the resource, eg \code{Microsoft.Compute}.
 \item \code{path}: The path to the resource, eg \code{virtualMachines}.
 \item \code{type}: The combination of provider and path, eg \code{Microsoft.Compute/virtualMachines}.
@@ -56,7 +57,7 @@ The \code{do_operation()} method allows you to carry out arbitrary operations on
 \itemize{
 \item \code{op}: The operation in question, which will be appended to the URL path of the request.
 \item \code{options}: A named list giving the URL query parameters.
-\item \code{...}: Other named arguments passed to \link{call_azure_rm}, and then to the appropriate call in httr. In particular, use \code{body} to supply the body of a request.
+\item \code{...}: Other named arguments passed to \link{call_azure_rm}, and then to the appropriate call in httr. In particular, use \code{body} to supply the body of a PUT, POST or PATCH request.
 \item \code{http_verb}: The HTTP verb as a string, one of \code{GET}, \code{PUT}, \code{POST}, \code{DELETE}, \code{HEAD} or \code{PATCH}.
 }