Get-AzureRmIntegrationAccountGeneratedIcn
This cmdlet retrieves the current value of the generated interchange control number per agreement.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmIntegrationAccountGeneratedIcn
-ResourceGroupName <String>
-Name <String>
[-AgreementName <String>]
[-AgreementType <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
This cmdlet is meant to be used in disaster recovery scenarios to retrieve the current value of the generated interchange control number so to write back an increased value with Set-AzureRmIntegrationAccountGeneratedIcn. The interchange control number should be increased to avoid duplicate interchange control numbers for the numbers that could not yet be replicated to the passive region when the disaster happened in the active region. Please do provide the "-AgreementType" parameter to specify whether X12 or Edifact control numbers to return
Examples
Example 1
PS C:\> Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "X12IntegrationAccountAgreement"
ControlNumber : 1000
ControlNumberChangedTime : 2/15/2017 12:36:00 AM
IsMessageProcessingFailed:This command gets the integration account generated X12 interchange control number by agreement name. Please make sure agreement specified is of type "X12"
Example 2
PS C:\> Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType "Edifact" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1" -AgreementName "EdifactIntegrationAccountAgreement"
ControlNumber : 1000
ControlNumberChangedTime : 2/15/2017 12:36:00 AM
IsMessageProcessingFailed:This command gets the integration account generated Edifact interchange control number by agreement name. Please make sure agreement specified is of type "Edifact"
Example 3
PS C:\> Get-AzureRmIntegrationAccountGeneratedIcn -AgreementType "X12" -ResourceGroupName "ResourceGroup1" -Name "IntegrationAccount1"
ControlNumber : 1000
ControlNumberChangedTime : 2/22/2017 8:05:41 PM
AgreementName : X12IntegrationAccountAgreement1
IsMessageProcessingFailed:
ControlNumber : 1000
ControlNumberChangedTime : 2/22/2017 8:05:41 PM
AgreementName : X12IntegrationAccountAgreement2
IsMessageProcessingFailed:
ControlNumber : No generated control number was found for this agreement.
ControlNumberChangedTime : 1/1/0001 12:00:00 AM
AgreementName : X12IntegrationAccountAgreement3
IsMessageProcessingFailed:This command gets all the generated X12 interchange control numbers by integration account name.
Parameters
-AgreementName
The integration account agreement name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AgreementType
The integration account agreement type.
| Type: | String |
| Aliases: | MessageType |
| Accepted values: | X12, Edifact |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
The integration account name.
| Type: | String |
| Aliases: | ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The integration account resource group name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
Outputs
IntegrationAccountControlNumber