pub struct Client(_);
Implementations§
source§impl Client
impl Client
sourcepub fn get_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn get_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Gets a deployment.
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.
sourcepub fn create_or_update_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<Deployment>
) -> RequestBuilder
pub fn create_or_update_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<Deployment> ) -> RequestBuilder
Deploys resources at a given scope. You can provide the template and parameters directly in the request or link to JSON files.
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.parameters
: Additional parameters supplied to the operation.
sourcepub fn delete_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn delete_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.
sourcepub fn check_existence_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn check_existence_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Checks whether the deployment exists.
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.
sourcepub fn cancel_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn cancel_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.
sourcepub fn validate_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<Deployment>
) -> RequestBuilder
pub fn validate_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<Deployment> ) -> RequestBuilder
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.parameters
: Parameters to validate.
sourcepub fn export_template_at_scope(
&self,
scope: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn export_template_at_scope( &self, scope: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Exports the template used for specified deployment.
Arguments:
scope
: The resource scope.deployment_name
: The name of the deployment.
sourcepub fn list_at_scope(&self, scope: impl Into<String>) -> RequestBuilder
pub fn list_at_scope(&self, scope: impl Into<String>) -> RequestBuilder
Get all the deployments at the given scope.
Arguments:
scope
: The resource scope.
sourcepub fn get_at_tenant_scope(
&self,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn get_at_tenant_scope( &self, deployment_name: impl Into<String> ) -> RequestBuilder
Gets a deployment.
Arguments:
deployment_name
: The name of the deployment.
sourcepub fn create_or_update_at_tenant_scope(
&self,
deployment_name: impl Into<String>,
parameters: impl Into<ScopedDeployment>
) -> RequestBuilder
pub fn create_or_update_at_tenant_scope( &self, deployment_name: impl Into<String>, parameters: impl Into<ScopedDeployment> ) -> RequestBuilder
Deploys resources at tenant scope. You can provide the template and parameters directly in the request or link to JSON files.
Arguments:
deployment_name
: The name of the deployment.parameters
: Additional parameters supplied to the operation.
sourcepub fn delete_at_tenant_scope(
&self,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn delete_at_tenant_scope( &self, deployment_name: impl Into<String> ) -> RequestBuilder
Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Arguments:
deployment_name
: The name of the deployment.
sourcepub fn check_existence_at_tenant_scope(
&self,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn check_existence_at_tenant_scope( &self, deployment_name: impl Into<String> ) -> RequestBuilder
Checks whether the deployment exists.
Arguments:
deployment_name
: The name of the deployment.
sourcepub fn cancel_at_tenant_scope(
&self,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn cancel_at_tenant_scope( &self, deployment_name: impl Into<String> ) -> RequestBuilder
Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Arguments:
deployment_name
: The name of the deployment.
sourcepub fn validate_at_tenant_scope(
&self,
deployment_name: impl Into<String>,
parameters: impl Into<ScopedDeployment>
) -> RequestBuilder
pub fn validate_at_tenant_scope( &self, deployment_name: impl Into<String>, parameters: impl Into<ScopedDeployment> ) -> RequestBuilder
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Arguments:
deployment_name
: The name of the deployment.parameters
: Parameters to validate.
sourcepub fn what_if_at_tenant_scope(
&self,
deployment_name: impl Into<String>,
parameters: impl Into<ScopedDeploymentWhatIf>
) -> RequestBuilder
pub fn what_if_at_tenant_scope( &self, deployment_name: impl Into<String>, parameters: impl Into<ScopedDeploymentWhatIf> ) -> RequestBuilder
Returns changes that will be made by the deployment if executed at the scope of the tenant group.
Arguments:
deployment_name
: The name of the deployment.parameters
: Parameters to validate.
sourcepub fn export_template_at_tenant_scope(
&self,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn export_template_at_tenant_scope( &self, deployment_name: impl Into<String> ) -> RequestBuilder
Exports the template used for specified deployment.
Arguments:
deployment_name
: The name of the deployment.
sourcepub fn list_at_tenant_scope(&self) -> RequestBuilder
pub fn list_at_tenant_scope(&self) -> RequestBuilder
Get all the deployments at the tenant scope.
sourcepub fn get_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn get_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Gets a deployment.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.
sourcepub fn create_or_update_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<ScopedDeployment>
) -> RequestBuilder
pub fn create_or_update_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<ScopedDeployment> ) -> RequestBuilder
Deploys resources at management group scope. You can provide the template and parameters directly in the request or link to JSON files.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.parameters
: Additional parameters supplied to the operation.
sourcepub fn delete_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn delete_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.
sourcepub fn check_existence_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn check_existence_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Checks whether the deployment exists.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.
sourcepub fn cancel_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn cancel_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.
sourcepub fn validate_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<ScopedDeployment>
) -> RequestBuilder
pub fn validate_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<ScopedDeployment> ) -> RequestBuilder
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.parameters
: Parameters to validate.
sourcepub fn what_if_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<ScopedDeploymentWhatIf>
) -> RequestBuilder
pub fn what_if_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<ScopedDeploymentWhatIf> ) -> RequestBuilder
Returns changes that will be made by the deployment if executed at the scope of the management group.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.parameters
: Parameters to validate.
sourcepub fn export_template_at_management_group_scope(
&self,
group_id: impl Into<String>,
deployment_name: impl Into<String>
) -> RequestBuilder
pub fn export_template_at_management_group_scope( &self, group_id: impl Into<String>, deployment_name: impl Into<String> ) -> RequestBuilder
Exports the template used for specified deployment.
Arguments:
group_id
: The management group ID.deployment_name
: The name of the deployment.
sourcepub fn list_at_management_group_scope(
&self,
group_id: impl Into<String>
) -> RequestBuilder
pub fn list_at_management_group_scope( &self, group_id: impl Into<String> ) -> RequestBuilder
Get all the deployments for a management group.
Arguments:
group_id
: The management group ID.
sourcepub fn get_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn get_at_subscription_scope( &self, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Gets a deployment.
Arguments:
deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn create_or_update_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
parameters: impl Into<Deployment>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn create_or_update_at_subscription_scope( &self, deployment_name: impl Into<String>, parameters: impl Into<Deployment>, subscription_id: impl Into<String> ) -> RequestBuilder
Deploys resources at subscription scope. You can provide the template and parameters directly in the request or link to JSON files.
Arguments:
deployment_name
: The name of the deployment.parameters
: Additional parameters supplied to the operation.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn delete_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn delete_at_subscription_scope( &self, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Arguments:
deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn check_existence_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn check_existence_at_subscription_scope( &self, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Checks whether the deployment exists.
Arguments:
deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn cancel_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn cancel_at_subscription_scope( &self, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.
Arguments:
deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn validate_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
parameters: impl Into<Deployment>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn validate_at_subscription_scope( &self, deployment_name: impl Into<String>, parameters: impl Into<Deployment>, subscription_id: impl Into<String> ) -> RequestBuilder
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Arguments:
deployment_name
: The name of the deployment.parameters
: Parameters to validate.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn what_if_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
parameters: impl Into<DeploymentWhatIf>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn what_if_at_subscription_scope( &self, deployment_name: impl Into<String>, parameters: impl Into<DeploymentWhatIf>, subscription_id: impl Into<String> ) -> RequestBuilder
Returns changes that will be made by the deployment if executed at the scope of the subscription.
Arguments:
deployment_name
: The name of the deployment.parameters
: Parameters to What If.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn export_template_at_subscription_scope(
&self,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn export_template_at_subscription_scope( &self, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Exports the template used for specified deployment.
Arguments:
deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn list_at_subscription_scope(
&self,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn list_at_subscription_scope( &self, subscription_id: impl Into<String> ) -> RequestBuilder
Get all the deployments for a subscription.
Arguments:
subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn get(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn get( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Gets a deployment.
Arguments:
resource_group_name
: The name of the resource group. The name is case insensitive.deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn create_or_update(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<Deployment>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn create_or_update( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<Deployment>, subscription_id: impl Into<String> ) -> RequestBuilder
Deploys resources to a resource group. You can provide the template and parameters directly in the request or link to JSON files.
Arguments:
resource_group_name
: The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.deployment_name
: The name of the deployment.parameters
: Additional parameters supplied to the operation.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn delete(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn delete( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Deletes a deployment from the deployment history. A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.
Arguments:
resource_group_name
: The name of the resource group with the deployment to delete. The name is case insensitive.deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn check_existence(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn check_existence( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Checks whether the deployment exists.
Arguments:
resource_group_name
: The name of the resource group with the deployment to check. The name is case insensitive.deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn cancel(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn cancel( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Cancels a currently running template deployment. You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.
Arguments:
resource_group_name
: The name of the resource group. The name is case insensitive.deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn validate(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<Deployment>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn validate( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<Deployment>, subscription_id: impl Into<String> ) -> RequestBuilder
Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..
Arguments:
resource_group_name
: The name of the resource group the template will be deployed to. The name is case insensitive.deployment_name
: The name of the deployment.parameters
: Parameters to validate.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn what_if(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
parameters: impl Into<DeploymentWhatIf>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn what_if( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, parameters: impl Into<DeploymentWhatIf>, subscription_id: impl Into<String> ) -> RequestBuilder
Returns changes that will be made by the deployment if executed at the scope of the resource group.
Arguments:
resource_group_name
: The name of the resource group the template will be deployed to. The name is case insensitive.deployment_name
: The name of the deployment.parameters
: Parameters to validate.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn export_template(
&self,
resource_group_name: impl Into<String>,
deployment_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn export_template( &self, resource_group_name: impl Into<String>, deployment_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Exports the template used for specified deployment.
Arguments:
resource_group_name
: The name of the resource group. The name is case insensitive.deployment_name
: The name of the deployment.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn list_by_resource_group(
&self,
resource_group_name: impl Into<String>,
subscription_id: impl Into<String>
) -> RequestBuilder
pub fn list_by_resource_group( &self, resource_group_name: impl Into<String>, subscription_id: impl Into<String> ) -> RequestBuilder
Get all the deployments for a resource group.
Arguments:
resource_group_name
: The name of the resource group with the deployments to get. The name is case insensitive.subscription_id
: The Microsoft Azure subscription ID.
sourcepub fn calculate_template_hash(
&self,
template: impl Into<Value>
) -> RequestBuilder
pub fn calculate_template_hash( &self, template: impl Into<Value> ) -> RequestBuilder
Calculate the hash of the given template.
Arguments:
template
: The template provided to calculate hash.