C# Class Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkClient.ResourceManagerSdkClient

Mostra file Open project: Azure/azure-powershell Class Usage Examples

Public Properties

Property	Type	Description
KnownLocations	List

Public Methods

Method	Description
CancelDeployment ( string resourceGroup, string deploymentName ) : void	Cancels the active deployment.
CreatePSResourceGroup ( PSCreateResourceGroupParameters parameters ) : PSResourceGroup	Creates a new resource group
DeleteDeployment ( string resourceGroup, string deploymentName ) : void	Deletes a deployment
DeleteResourceGroup ( string name ) : void	Deletes a given resource group
ExecuteDeployment ( PSCreateResourceGroupDeploymentParameters parameters ) : PSResourceGroupDeployment	Creates new deployment
FilterResourceGroupDeployments ( FilterResourceGroupDeploymentOptions options ) : List	Filters the resource group deployments
FilterResourceGroups ( string name, Hashtable tag, bool detailed, string location = null ) : List	Filters the subscription's resource groups.
GetRegisteredProviders ( List providers ) : List
ListResourceProviders ( string providerName = null, bool listAvailable = true ) : List
ParseDetailErrorMessage ( string statusMessage ) : List
ParseResourceIds ( string resourceIds ) : Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components.ResourceIdentifier[]	Parses an array of resource ids to extract the resource group name
ProvisionDeploymentStatus ( string resourceGroup, string deploymentName, Deployment deployment ) : DeploymentExtended
RegisterProvider ( string providerName ) : PSResourceProvider
ResourceManagerSdkClient ( ) : System	Parameterless constructor for mocking
ResourceManagerSdkClient ( AzureContext context ) : System	Creates new ResourceManagementClient
ResourceManagerSdkClient ( IResourceManagementClient resourceManagementClient ) : System	Creates new ResourcesClient instance
SerializeHashtable ( Hashtable templateParameterObject, bool addValueLayer ) : string
UnregisterProvider ( string providerName ) : PSResourceProvider
UpdatePSResourceGroup ( PSUpdateResourceGroupParameters parameters ) : PSResourceGroup	Updates a resource group.
ValidatePSResourceGroupDeployment ( PSValidateResourceGroupDeploymentParameters parameters, DeploymentMode deploymentMode ) : List	Validates a given deployment.

Private Methods

Method	Description
CheckBasicDeploymentErrors ( string resourceGroup, string deploymentName, Deployment deployment ) : TemplateValidationInfo
CreateBasicDeployment ( PSValidateResourceGroupDeploymentParameters parameters, DeploymentMode deploymentMode, string debugSetting ) : Deployment
CreateOrUpdateResourceGroup ( string name, string location, Hashtable tags ) : ResourceGroup
DisplayInnerDetailErrorMessage ( ResourceManagementErrorWithDetails error ) : void
GenerateDeploymentName ( PSCreateResourceGroupDeploymentParameters parameters ) : string
GetDeploymentParameters ( Hashtable templateParameterObject ) : string
GetNewOperations ( List old, IPage current ) : List
GetTemplate ( string templateFile ) : string
IsProviderRegistered ( Provider provider ) : bool
WaitDeploymentStatus ( string resourceGroup, string deploymentName, Deployment basicDeployment, Action job ) : DeploymentExtended
WriteDeploymentProgress ( string resourceGroup, string deploymentName, Deployment deployment ) : void
WriteError ( string error ) : void
WriteVerbose ( string progress ) : void
WriteWarning ( string warning ) : void

Method Details

CancelDeployment() public method

Cancels the active deployment.

public CancelDeployment ( string resourceGroup, string deploymentName ) : void
resourceGroup	string	The resource group name
deploymentName	string	Deployment name
return	void

CreatePSResourceGroup() public method

Creates a new resource group

public CreatePSResourceGroup ( PSCreateResourceGroupParameters parameters ) : PSResourceGroup
parameters	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSCreateResourceGroupParameters	The create parameters
return	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroup

DeleteDeployment() public method

Deletes a deployment

public DeleteDeployment ( string resourceGroup, string deploymentName ) : void
resourceGroup	string	The resource group name
deploymentName	string	Deployment name
return	void

DeleteResourceGroup() public method

Deletes a given resource group

public DeleteResourceGroup ( string name ) : void
name	string	The resource group name
return	void

ExecuteDeployment() public method

Creates new deployment

public ExecuteDeployment ( PSCreateResourceGroupDeploymentParameters parameters ) : PSResourceGroupDeployment
parameters	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSCreateResourceGroupDeploymentParameters	The create deployment parameters
return	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroupDeployment

FilterResourceGroupDeployments() public method

Filters the resource group deployments

public FilterResourceGroupDeployments ( FilterResourceGroupDeploymentOptions options ) : List
options	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.FilterResourceGroupDeploymentOptions	The filtering options
return	List

FilterResourceGroups() public method

Filters the subscription's resource groups.

public FilterResourceGroups ( string name, Hashtable tag, bool detailed, string location = null ) : List
name	string	The resource group name.
tag	System.Collections.Hashtable	The resource group tag.
detailed	bool	Whether the return is detailed or not.
location	string	The resource group location.
return	List

GetRegisteredProviders() public method

public GetRegisteredProviders ( List providers ) : List
providers	List
return	List

ListResourceProviders() public method

public ListResourceProviders ( string providerName = null, bool listAvailable = true ) : List
providerName	string
listAvailable	bool
return	List

ParseDetailErrorMessage() public static method

public static ParseDetailErrorMessage ( string statusMessage ) : List
statusMessage	string
return	List

ParseResourceIds() public method

Parses an array of resource ids to extract the resource group name

public ParseResourceIds ( string resourceIds ) : Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components.ResourceIdentifier[]
resourceIds	string	An array of resource ids
return	Microsoft.Azure.Commands.ResourceManager.Cmdlets.Components.ResourceIdentifier[]

ProvisionDeploymentStatus() public method

public ProvisionDeploymentStatus ( string resourceGroup, string deploymentName, Deployment deployment ) : DeploymentExtended
resourceGroup	string
deploymentName	string
deployment	Deployment
return	DeploymentExtended

RegisterProvider() public method

public RegisterProvider ( string providerName ) : PSResourceProvider
providerName	string
return	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceProvider

ResourceManagerSdkClient() public method

Parameterless constructor for mocking

public ResourceManagerSdkClient ( ) : System
return	System

ResourceManagerSdkClient() public method

Creates new ResourceManagementClient

public ResourceManagerSdkClient ( AzureContext context ) : System
context	Microsoft.Azure.Commands.Common.Authentication.Models.AzureContext	Profile containing resources to manipulate
return	System

ResourceManagerSdkClient() public method

Creates new ResourcesClient instance

public ResourceManagerSdkClient ( IResourceManagementClient resourceManagementClient ) : System
resourceManagementClient	IResourceManagementClient	The IResourceManagementClient instance
return	System

SerializeHashtable() public method

public SerializeHashtable ( Hashtable templateParameterObject, bool addValueLayer ) : string
templateParameterObject	System.Collections.Hashtable
addValueLayer	bool
return	string

UnregisterProvider() public method

public UnregisterProvider ( string providerName ) : PSResourceProvider
providerName	string
return	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceProvider

UpdatePSResourceGroup() public method

Updates a resource group.

public UpdatePSResourceGroup ( PSUpdateResourceGroupParameters parameters ) : PSResourceGroup
parameters	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSUpdateResourceGroupParameters	The create parameters
return	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSResourceGroup

ValidatePSResourceGroupDeployment() public method

Validates a given deployment.

public ValidatePSResourceGroupDeployment ( PSValidateResourceGroupDeploymentParameters parameters, DeploymentMode deploymentMode ) : List
parameters	Microsoft.Azure.Commands.ResourceManager.Cmdlets.SdkModels.PSValidateResourceGroupDeploymentParameters	The deployment create options
deploymentMode	DeploymentMode
return	List

Property Details

KnownLocations public_oe static_oe property

public static List KnownLocations
return	List