Provance.Azure.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Get-ProvAzureAuthContext --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureAuthContext</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureAuthContext</command:noun> <maml:description> <maml:para>Make an HTTP POST request to a token service to obtain an access token.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet can authenticate to Azure and Dynamics 365 (ProvanceITSM) to get an OAuth2 token for further processing with REST API requests.</maml:para> <maml:para>It supports 3 different ways to authenticate.</maml:para> <maml:para>1.) "Client Credential"</maml:para> <maml:para>The input is a PS Credential object, consisting of ClientID (Azure AppId) and ClientKey(AppKey)</maml:para> <maml:para>2.) "User Credential"</maml:para> <maml:para>The input type is a PS Credential object, consisting of Username and Password</maml:para> <maml:para>3.) "Refresh Token with User Credentials"</maml:para> <maml:para>When the authentication mechanism is providing a refresh-token, this token can be used in junction with a PSCredential user object to re-authenticate (does not work with an Appid/AppKey pair)</maml:para> <maml:para>The Cmdlet generates a PSObject of the type Provance.Azure.Common.OAuth2 with all the properties from the access token plus the TenantID, to be used in the header of API rest requests to query Azure or Dynamics CRM</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Oauth2 With Client Credential --> <command:syntaxItem> <maml:name>Get-ProvAzureAuthContext</maml:name> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClientCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClientCredential</maml:name> <maml:description> <maml:para>The client credential pair (AppID and AppKey) of a Azure AD App as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to authenticate with. Defaults to "https://management.core.windows.net/".</maml:para> <maml:para>When authenticating to a CRM instance, use i.e. "https://youritsminstance.dynamics.com/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://management.core.windows.net/</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Oauth2 With User Credential --> <command:syntaxItem> <maml:name>Get-ProvAzureAuthContext</maml:name> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserCredential</maml:name> <maml:description> <maml:para>The UserName/Password credential as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to authenticate with. Defaults to "https://management.core.windows.net/".</maml:para> <maml:para>When authenticating to a CRM instance, use i.e. "https://youritsminstance.dynamics.com/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://management.core.windows.net/</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Oauth2 Refresh Token With User Credential --> <command:syntaxItem> <maml:name>Get-ProvAzureAuthContext</maml:name> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OAuth2 --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OAuth2</maml:name> <maml:description> <maml:para>The credential context, used only for refresh token</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UserCredential</maml:name> <maml:description> <maml:para>The UserName/Password credential as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClientCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClientCredential</maml:name> <maml:description> <maml:para>The client credential pair (AppID and AppKey) of a Azure AD App as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserCredential</maml:name> <maml:description> <maml:para>The UserName/Password credential as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OAuth2 --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OAuth2</maml:name> <maml:description> <maml:para>The credential context, used only for refresh token</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to authenticate with. Defaults to "https://management.core.windows.net/".</maml:para> <maml:para>When authenticating to a CRM instance, use i.e. "https://youritsminstance.dynamics.com/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://management.core.windows.net/</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: OAuth2 --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.OAuth2</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Authenticating with a PScredential object of an Appid/AppKey pair. $token = Get-ProvAzureAuthContext -TenantId $TenantId -ClientCredential $ClientCred Parameterset used is "Client Credential" and authentication happens against the default resource "https://management.core.windows.net/" First, define values for parameters in the correct type and create a PSCredential object, which you will use later on in the command. $tenantId = '86f73a5a-7e3d-4aa7-8f2d-20a69708fbc7' $ClientId = '0000aaaa-11bb-22cc-33dd-fdcb12345678' $ClientKey = 'aaaaaaaabbbbbbbbccccccccdddddddd33333333fffff=' $SecClientKey = ConvertTo-SecureString $ClientKey -AsPlainText -Force $ClientCred = New-Object -TypeName PSCredential -ArgumentList $ClientId,$SecClientKey $tenantID is the GUID of the Azure Active directory you are going to authenticate to. $AppIdCred is generated from the AppID and AppKey strings Then run the command to get the Authorization token, as shown above. !! Note !! Never store passwords in plaintext in Scripts. Use Assets in Azure automation, Azure Keyvault or store the Credential object as encrypted CliXML file on a local hard disk or network share</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Authenticating against Dynamics CRM with UserName and Password. $token = Get-ProvAzureAuthContext -TenantId $CRMTenantId -UserCredential $CRMUser -Resource $crmUrl -Verbose In this example, we use the Parameterset "User Credential". Authentication happens against a CRM Instance, stored in $crmURL First, define values for parameters in the correct type and create a PSCredential object, which you will use later on in the command. $CRMtenantid = '95a73f5f-7d3d-4bb7-8f2d-20a63708fea1' $crmUrl = "https://itsm03.crm3.dynamics.com/" $crmUser = "yourcrmuser@itsmnn.onmicrosoft.com" $crmPsw = ConvertTo-SecureString -String "NEVERSTOREPASSWORDSINSCRIPTS" -AsPlainText -Force $credCRM = New-Object -TypeName PSCredential -ArgumentList $crmU,$crmPsw Then run the command to get the Authorization token, as shown above. !! Note !! Never store passwords in plaintext in Scripts. Use Assets in Azure automation, Azure Keyvault or store the credential object as encrypted CliXML on a local hard disk or network share</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>In this example, we use the Parameterset "Oauth2 Refresh Token With User Credential". Authentication happens against a CRM Instance, stored in $crmURL. The difference to example 2 is that we additionally use a refresh token coming from the first authentication. The refresh token is stored in the $token object from another authentication attempt. $token = Get-ProvAzureAuthContext -TenantId $crmTenantId -OAuth2 $crmToken -UserCredential $credCRM -Resource $crmUrl In this example, we use the Parameterset "User Credential". Authentication happens against a CRM Instance, stored in $crmURL First, define values for parameters in the correct type and create a PSCredential object, which you will use later on in the command. $CRMtenantid = '95f73a5a-7e3d-4aa7-8f2d-20a69708fbd8' $crmUrl = "https://itsm03.crm3.dynamics.com/" $crmUser = "yourcrmuser@itsmnn.onmicrosoft.com" $crmPsw = ConvertTo-SecureString -String "NEVERSTOREPASSWORDSINSCRIPTS" -AsPlainText -Force $credCRM = New-Object -TypeName PSCredential -ArgumentList $crmU,$crmPsw $OAuth2 = $crmtoken Then run the command to get the Authorization token, as shown above. !! Note !! Never store passwords in plaintext in Scripts. Use Assets in Azure automation, Azure Keyvault or store the Credential object as encrypted CliXML on a local hard disk or network share</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvAzureAuthContextADAL --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureAuthContextADAL</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureAuthContextADAL</command:noun> <maml:description> <maml:para>Make an HTTP POST request to a token service to obtain an access token.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet can authenticate to Azure and Dynamics 365 (ProvanceITSM) to get an OAuth2 token for further processing with REST API requests.</maml:para> <maml:para>It supports 3 different ways to authenticate.</maml:para> <maml:para>The options are defined in parametersets which are:</maml:para> <maml:para>1.) "Client Credential" - the input is a PS Credential object, consisting of Client ID and ClientKey(also references as AppID/AppKey)</maml:para> <maml:para>2.) "User Credential" - the input type is a PS Credential object, consisting of Username and Password</maml:para> <maml:para>3.) "Refresh Token with User Credentials" - When the authentication mechanism is providing a refresh-token, this token can be used in junction with a PSCredential user object to re-authenticate (does not work with Appid/AppKey)</maml:para> <maml:para>The Cmdlet generates a PSObject of the type Provance.Azure.Common.OAuth2 with all the properties from the access token plus the TenantID, to be used in the header of API rest requests to query Azure or Dynamics CRM</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Oauth2 With Client Credential --> <command:syntaxItem> <maml:name>Get-ProvAzureAuthContextADAL</maml:name> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClientCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClientCredential</maml:name> <maml:description> <maml:para>The client credential pair (AppID and AppKey) of a Azure AD App as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to authenticate with. Defaults to "https://management.core.windows.net/".</maml:para> <maml:para>When authenticating to a CRM instance, use i.e. "https://youritsminstance.dynamics.com/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://management.core.windows.net/</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Oauth2 With User Credential --> <command:syntaxItem> <maml:name>Get-ProvAzureAuthContextADAL</maml:name> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserCredential</maml:name> <maml:description> <maml:para>The UserName/Password credential as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to authenticate with. Defaults to "https://management.core.windows.net/".</maml:para> <maml:para>When authenticating to a CRM instance, use i.e. "https://youritsminstance.dynamics.com/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://management.core.windows.net/</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Oauth2 Refresh Token With User Credential --> <command:syntaxItem> <maml:name>Get-ProvAzureAuthContextADAL</maml:name> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OAuth2 --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OAuth2</maml:name> <maml:description> <maml:para>The credential context, used only for refresh token</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>UserCredential</maml:name> <maml:description> <maml:para>The UserName/Password credential as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: TenantId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>TenantId</maml:name> <maml:description> <maml:para>The GUID of the Azure Active Directory tenant as [GUID] Object. Find the tenant id in https://portal.azure.com</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ClientCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ClientCredential</maml:name> <maml:description> <maml:para>The client credential pair (AppID and AppKey) of a Azure AD App as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: UserCredential --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>UserCredential</maml:name> <maml:description> <maml:para>The UserName/Password credential as [PSCredential] object</maml:para> </maml:description> <command:parameterValue required="true">PSCredential</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.PSCredential</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OAuth2 --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OAuth2</maml:name> <maml:description> <maml:para>The credential context, used only for refresh token</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Resource --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Resource</maml:name> <maml:description> <maml:para>The resource to authenticate with. Defaults to "https://management.core.windows.net/".</maml:para> <maml:para>When authenticating to a CRM instance, use i.e. "https://youritsminstance.dynamics.com/".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>https://management.core.windows.net/</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: OAuth2 --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.OAuth2</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Authenticating with a PScredential object of an Appid/AppKey pair. $token = Get-ProvAzureAuthContext -TenantId $TenantId -ClientCredential $ClientCred Parameterset used is "Client Credential" and authentication happens against the default resource "https://management.core.windows.net/" First, define values for parameters in the correct type and create a PSCredential object, which you will use later on in the command. $tenantId = '86f73a5a-7e3d-4aa7-8f2d-20a69708fbc7' $ClientId = '0000aaaa-11bb-22cc-33dd-fdcb12345678' $ClientKey = 'aaaaaaaabbbbbbbbccccccccdddddddd33333333fffff=' $SecClientKey = ConvertTo-SecureString $ClientKey -AsPlainText -Force $ClientCred = New-Object -TypeName PSCredential -ArgumentList $ClientId,$SecClientKey $tenantID is the GUID of the Azure Active directory you are going to authenticate to. $AppIdCred is generated from the AppID and AppKey strings Then run the command to get the Authorization token, as shown above. !! Note !! Never store passwords in plaintext in Scripts. Use Assets in Azure automation, Azure Keyvault or store the Credential object as encrypted CliXML file on a local hard disk or network share</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Authenticating against Dynamics CRM with UserName and Password. $token = Get-ProvAzureAuthContext -TenantId $CRMTenantId -UserCredential $CRMUser -Resource $crmUrl -Verbose In this example, we use the Parameterset "User Credential". Authentication happens against a CRM Instance, stored in $crmURL First, define values for parameters in the correct type and create a PSCredential object, which you will use later on in the command. $CRMtenantid = '95a73f5f-7d3d-4bb7-8f2d-20a63708fea1' $crmUrl = "https://itsm03.crm3.dynamics.com/" $crmUser = "yourcrmuser@itsmnn.onmicrosoft.com" $crmPsw = ConvertTo-SecureString -String "NEVERSTOREPASSWORDSINSCRIPTS" -AsPlainText -Force $credCRM = New-Object -TypeName PSCredential -ArgumentList $crmU,$crmPsw Then run the command to get the Authorization token, as shown above. !! Note !! Never store passwords in plaintext in Scripts. Use Assets in Azure automation, Azure Keyvault or store the credential object as encrypted CliXML on a local hard disk or network share</dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>In this example, we use the Parameterset "Oauth2 Refresh Token With User Credential". Authentication happens against a CRM Instance, stored in $crmURL. The difference to example 2 is that we additionally use a refresh token coming from the first authentication. The refresh token is stored in the $token object from another authentication attempt. $token = Get-ProvAzureAuthContext -TenantId $crmTenantId -OAuth2 $crmToken -UserCredential $credCRM -Resource $crmUrl In this example, we use the Parameterset "User Credential". Authentication happens against a CRM Instance, stored in $crmURL First, define values for parameters in the correct type and create a PSCredential object, which you will use later on in the command. $CRMtenantid = '95f73a5a-7e3d-4aa7-8f2d-20a69708fbd8' $crmUrl = "https://itsm03.crm3.dynamics.com/" $crmUser = "yourcrmuser@itsmnn.onmicrosoft.com" $crmPsw = ConvertTo-SecureString -String "NEVERSTOREPASSWORDSINSCRIPTS" -AsPlainText -Force $credCRM = New-Object -TypeName PSCredential -ArgumentList $crmU,$crmPsw $OAuth2 = $crmtoken Then run the command to get the Authorization token, as shown above. !! Note !! Never store passwords in plaintext in Scripts. Use Assets in Azure automation, Azure Keyvault or store the Credential object as encrypted CliXML on a local hard disk or network share</dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvAzureProvider --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureProvider</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureProvider</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureProvider</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscriptionid --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscriptionid</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the Resource Group has been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups for more.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2018-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the provider to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RegisteredOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegisteredOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The Name of the provider to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups for more.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2018-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: Subscriptionid --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscriptionid</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the Resource Group has been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The Name of the provider to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceType --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceType</maml:name> <maml:description> <maml:para>The Name of the provider to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: RegisteredOnly --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RegisteredOnly</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Hashtable --> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ProvAzureResource --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureResource</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureResource</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureResource</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscriptionid --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscriptionid</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the Resource Group has been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups for more.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2018-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Resource Group to look for.</maml:para> <maml:para>If this parameteris not specified, all Resource Groups of the Subscriptions will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncOnlyTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncOnlyTag</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the resource to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups for more.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2018-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: Subscriptionid --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscriptionid</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the Resource Group has been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Resource Group to look for.</maml:para> <maml:para>If this parameteris not specified, all Resource Groups of the Subscriptions will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Type --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of the resource to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncOnlyTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncOnlyTag</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Hashtable --> <command:returnValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ProvAzureResourceGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureResourceGroup</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureResourceGroup</command:noun> <maml:description> <maml:para>Read details of an Azure Resource Group.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet connects to the Azure REST API and reads resource group details for further processing with REST API requests.</maml:para> <maml:para>A PSobject of type Provance.Azure.ResourceManager.Tenant, to be used in further commandlets.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureResourceGroup</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Subscriptionid --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscriptionid</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the Resource Group has been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups for more.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2018-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroupName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Resource Group to look for.</maml:para> <maml:para>If this parameteris not specified, all Resource Groups of the Subscriptions will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/resourcegroups for more.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2018-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: Subscriptionid --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Subscriptionid</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the Resource Group has been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroupName --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>The name of the Resource Group to look for.</maml:para> <maml:para>If this parameteris not specified, all Resource Groups of the Subscriptions will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ResourceGroup --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.ResourceGroup</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Retrieving Azure Resource Group details $myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId 'f56127c0-7c3e-4994-8733-e14eaf7864c8' -ResourceGroupName 'VirtualMachines' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Retrieving details of all Azure Resource Groups in the subscription $myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId 'f56127c0-7c3e-4994-8733-e14eaf7864c8' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvAzureServiceMapMachine --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureServiceMapMachine</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureServiceMapMachine</command:noun> <maml:description> <maml:para>Retrieves the list of Azure OMS Service Map Machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This commandlet retrieves all machines of a Service Map workspace.</maml:para> <maml:para>The output can be limited by filtering either by DisplayName of MachineName (the Id).</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureServiceMapMachine</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OMSContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OMSContext</maml:name> <maml:description> <maml:para>"The OMS Workspace where the ResourceManager Solution resided, needs to be defined first."</maml:para> <maml:para>Use the command Set-ProvAzueOMSWorkspace, store the output in a variable (i.e. $OmsWorkspace) and take this variable as input for this parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>"Service map Machines have Display Names. "</maml:para> <maml:para>""</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>"Service map Machines have Machine Names."</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OMSContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OMSContext</maml:name> <maml:description> <maml:para>"The OMS Workspace where the ResourceManager Solution resided, needs to be defined first."</maml:para> <maml:para>Use the command Set-ProvAzueOMSWorkspace, store the output in a variable (i.e. $OmsWorkspace) and take this variable as input for this parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: MachineName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>MachineName</maml:name> <maml:description> <maml:para>"Service map Machines have Machine Names."</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>"Service map Machines have Display Names. "</maml:para> <maml:para>""</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>"Service map Machines have Machine Names."</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>"Service map Machines have Display Names. "</maml:para> <maml:para>""</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceMapMachine --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.ServiceMapMachine</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ProvAzureServiceMapMachineGroup --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureServiceMapMachineGroup</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureServiceMapMachineGroup</command:noun> <maml:description> <maml:para>Retrieves the list of Azure Service Map Groups.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This commandlet retrieves all servcie map groups of a Service Map workspace.</maml:para> <maml:para>The output can be limited by filtering by name of Service Map Group.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureServiceMapMachineGroup</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OMSContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OMSContext</maml:name> <maml:description> <maml:para>The OMS Workspace where the ResourceManager Solution resided, needs to be defined first.</maml:para> <maml:para>Use the command Set-ProvAzueOMSWorkspace, store the output in a variable (i.e. $OmsWorkspace) and take this variable as input for this parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the Azure REST API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>"Filter the Service Map Machine Groups by Display Name. "</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OMSContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>OMSContext</maml:name> <maml:description> <maml:para>The OMS Workspace where the ResourceManager Solution resided, needs to be defined first.</maml:para> <maml:para>Use the command Set-ProvAzueOMSWorkspace, store the output in a variable (i.e. $OmsWorkspace) and take this variable as input for this parameter.</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the Azure REST API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: DisplayName --> <command:parameter required="false" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>DisplayName</maml:name> <maml:description> <maml:para>"Filter the Service Map Machine Groups by Display Name. "</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>"Filter the Service Map Machine Groups by Display Name. "</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: ServiceMapMachineGroup --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.ServiceMapMachineGroup</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Retrieve all Machine Groups beginning with "W" $MachineGroupDisplayName = "Hardware" Get-ProvAzureServiceMapMachineGroup -AuthContext $token -OMSContext $smWrkSpc -DisplayName $MachineGroupDisplayName The $token object shall be generated with "Get-ProvAzureAuthContext" first </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Get-ProvAzureServiceMapWorkspace --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureServiceMapWorkspace</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureServiceMapWorkspace</command:noun> <maml:description> <maml:para>Read details of a Azure Service Map (Loganalytics) Workspace.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet connects to the Azure REST API and reads details Of an Azure Service Map Workspace.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureServiceMapWorkspace</maml:name> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the subscription the workspace is installed.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Resource Group the workspace is installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OMSWorkspace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OMSWorkspace</maml:name> <maml:description> <maml:para>The name of the Workspace</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="0"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the subscription the workspace is installed.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="1"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Resource Group the workspace is installed.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: OMSWorkspace --> <command:parameter required="true" globbing="false" pipelineInput="false" position="2"> <maml:name>OMSWorkspace</maml:name> <maml:description> <maml:para>The name of the Workspace</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API on Azure</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: ServiceMapWorkspace --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.ServiceMapWorkspace</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Retrieving Details of Azure Service Map Workspace $smWrkSpc must be defined first with Set-ProvAzureServiceMapWorkspace $smwrks = Get-ProvAzureServiceMapWorkspace -AuthContext $aCntx -OMSContext $smWrkSpc The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Retrieving details of all Azure Resource Groups in the subscription $myresourcegroup = Get-ProvAzureResourceGroup -AuthContext $token -SubscriptionId 'f56127c0-7c3e-4994-8733-e14eaf7864c8' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvAzureSubscription --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureSubscription</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureSubscription</command:noun> <maml:description> <maml:para>Read details of an Azure Subscription.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet connects to the Azure REST API and reads subscription details.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureSubscription</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/subscriptions for updates.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2016-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription to look for.</maml:para> <maml:para>If this parameter is not specified, all subscriptions will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the subscription to look for.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/subscriptions for updates.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2016-01-01</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the subscription to look for.</maml:para> <maml:para>If this parameter is not specified, all subscriptions will be returned.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the subscription to look for.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A valid authentication token, as provided by "Get-ProvAzureAuthContext"</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Subscription --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.Subscription</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Retrieve all Azure Subscriptions of a tenant $mysubscription = Get-ProvAzureSubscription -AuthContext $token The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Retrieve Azure Subscription(s) by Subscription Name $mysubscription = Get-ProvAzureSubscription -AuthContext $token -SubscriptionName 'Microsoft Partner*' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Retrieve one Azure Subscription by Subscription ID $mysubscription = Get-ProvAzureSubscription -AuthContext $token -SubscriptionID '90419738-1ef5-4c31-a142-0dc9603958e2' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvAzureTenant --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureTenant</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureTenant</command:noun> <maml:description> <maml:para>Read details of an Azure Active Directory tenant.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet connects to the Azure REST API and reads the tenant details for further processing with REST API requests. The tenant details are always retrieved for the tenantid stored in the OAuthToken.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureTenant</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/tenants for updates.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2016-01-01</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>A valid authentication token, as provided by "ProvAzureAuthContext"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The REST API Version used to read the data from Azure. Default is "2016-01-01", but may be changed due to updates in the REST API</maml:para> <maml:para>See https://docs.microsoft.com/en-us/rest/api/resources/tenants for updates.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2016-01-01</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>A valid authentication token, as provided by "ProvAzureAuthContext"</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: Tenant --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.Tenant</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Retrieving tenant details $mytenant = Get-ProvAzureTenant -AuthContext $token The $token object shall be generated with "Get-ProvAzureAuthContext" first </dev:code> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Provance Technologies Inc.</maml:linkText> <maml:uri>(http://provance.com)</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Help</maml:linkText> <maml:uri>(http://help.provance.com)</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> <!-- Cmdlet: Get-ProvAzureVM --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureVM</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureVM</command:noun> <maml:description> <maml:para>Retrieves the list of Azure virtual machines.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This commandlet retrieves all virtual machines from Azure subscription.</maml:para> <maml:para>The output can be limited by filtering either by name of virtual machine (the Id), or by resource group.</maml:para> </maml:description> <command:syntax> <!-- Parameter set: Subscription --> <command:syntaxItem> <maml:name>Get-ProvAzureVM</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeARMVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeARMVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeClassicVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeClassicVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncOnlyTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncOnlyTag</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Virtual Machine --> <command:syntaxItem> <maml:name>Get-ProvAzureVM</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Virtual Machine to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeARMVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeARMVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeClassicVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeClassicVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncOnlyTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncOnlyTag</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <!-- Parameter set: Resource Group --> <command:syntaxItem> <maml:name>Get-ProvAzureVM</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the resource group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeARMVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeARMVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeClassicVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeClassicVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: Name --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Virtual Machine to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SyncOnlyTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncOnlyTag</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the Virtual Machine to look for.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the resource group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ExcludeClassicVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeClassicVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: ExcludeARMVMs --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ExcludeARMVMs</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <!-- Parameter: SyncOnlyTag --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SyncOnlyTag</maml:name> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: VirtualMachine --> <command:returnValue> <dev:type> <maml:name>Provance.Azure.Common.Model.VirtualMachine</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <command:examples> <command:example> <maml:title>---------- EXAMPLE 1 ----------</maml:title> <dev:code>Retrieve all virtual machines from subscription $vm = Get-ProvAzureVirtualMachine -AuthContext $token -SubscriptionID '90419738-1ef5-4c31-a142-0dc9603958e2' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 2 ----------</maml:title> <dev:code>Retrieve virtual machines from the resource group $vm = Get-ProvAzureVirtualMachine -AuthContext $token -SubscriptionID '90419738-1ef5-4c31-a142-0dc9603958e2' -ResourceGroupName 'VirtualMachines' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> <command:example> <maml:title>---------- EXAMPLE 3 ----------</maml:title> <dev:code>Retrieve virtual machine by name $vm = Get-ProvAzureVirtualMachine -AuthContext $token -SubscriptionID '90419738-1ef5-4c31-a142-0dc9603958e2' -ResourceGroupName 'VirtualMachines' The $token object shall be generated with Get-ProvAzureAuthContext first </dev:code> </command:example> </command:examples> </command:command> <!-- Cmdlet: Invoke-ProvAzureVMAction --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-ProvAzureVMAction</command:name> <command:verb>Invoke</command:verb> <command:noun>ProvAzureVMAction</command:noun> <maml:description> <maml:para>Start/Stop/Restart/Deallocate Azure virtual machine.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-ProvAzureVMAction</maml:name> <!-- Parameter: Action --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The action to be invoke: Start - The operation to start a virtual machine. Stop - The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine. Deallocate - Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses. Restart - The operation to restart a virtual machine. Redeploy - The operation to redeploy a virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Action --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Action</maml:name> <maml:description> <maml:para>The action to be invoke: Start - The operation to start a virtual machine. Stop - The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine. Deallocate - Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses. Restart - The operation to restart a virtual machine. Redeploy - The operation to redeploy a virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: HttpStatusCode --> <command:returnValue> <dev:type> <maml:name>System.Net.HttpStatusCode</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ProvAzureVMInstanceView --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureVMInstanceView</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureVMInstanceView</command:noun> <maml:description> <maml:para>Returns the power state of the Azure virtual machine.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureVMInstanceView</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: JObject --> <command:returnValue> <dev:type> <maml:name>Newtonsoft.Json.Linq.JObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> <!-- Cmdlet: Get-ProvAzureVMPowerState --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Get-ProvAzureVMPowerState</command:name> <command:verb>Get</command:verb> <command:noun>ProvAzureVMPowerState</command:noun> <maml:description> <maml:para>Returns the power state of the Azure virtual machine.</maml:para> </maml:description> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Get-ProvAzureVMPowerState</maml:name> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: AuthContext --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>AuthContext</maml:name> <maml:description> <maml:para>The authorization context obtain with "Get-ProvAzureAuthContext".</maml:para> <maml:para>Store the output of this command in a variable and use it as input value for this parameter"</maml:para> </maml:description> <command:parameterValue required="true">object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: SubscriptionId --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>The GUID of the Azure Subscription where the virtual machines have been created.</maml:para> </maml:description> <command:parameterValue required="true">Guid</command:parameterValue> <dev:type> <maml:name>System.Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>00000000-0000-0000-0000-000000000000</dev:defaultValue> </command:parameter> <!-- Parameter: ResourceGroup --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>ResourceGroup</maml:name> <maml:description> <maml:para>The name of the Azure Resource Group contains the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Name --> <command:parameter required="true" globbing="false" pipelineInput="false" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the virtual machine.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: ApiVersion --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ApiVersion</maml:name> <maml:description> <maml:para>The version of the API to use.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues> <!-- OutputType: String --> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> </command:command> </helpItems> |