New-AzureRmIntegrationAccountAgreement
Creates an integration account 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
New-AzureRmIntegrationAccountAgreement
-ResourceGroupName <String>
-Name <String>
-AgreementName <String>
-AgreementType <String>
-GuestPartner <String>
-HostPartner <String>
-GuestIdentityQualifier <String>
-GuestIdentityQualifierValue <String>
-HostIdentityQualifier <String>
-HostIdentityQualifierValue <String>
[-AgreementContent <String>]
[-AgreementContentFilePath <String>]
[-Metadata <Object>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The New-AzureRmIntegrationAccountAgreement cmdlet creates an integration account agreement. This cmdlet returns an object that represents the integration account agreement. Specify the integration account name, resource group name, agreement name, type, partner name, partner qualifiers, and agreement content. Template parameter file values that you specify at the command line take precedence over template parameter values in a template parameter object. This module supports dynamic parameters. To use a dynamic parameter, type it in the command. To discover the names of dynamic parameters, type a hyphen (-) after the cmdlet name, and then press the Tab key repeatedly to cycle through the available parameters. If you omit a required template parameter, the cmdlet prompts you for the value.
Examples
Example 1: Create a integration account agreement
PS C:\>New-AzureRmIntegrationAccountAgreement -Name "IntegrationAccount31"-ResourceGroupName "ResourceGroup11" -AgreementName "IntegrationAccountAgreement06" -AgreementType "X12" -GuestPartner "GuestPartner" -HostPartner "HostPartner" -GuestIdentityQualifier "BB" -HostIdentityQualifier "AA" -AgreementContentFilePath "C:\temp\AgreementContent.json"
Id : /subscriptions/<SubscriptionId>/resourceGroups/ResourceGroup11/providers/Microsoft.Logic/integrationAccounts/IntegrationAccount31/agreements/IntegrationAccountAgreement06
Name : IntegrationAccountAgreement06
Type : Microsoft.Logic/integrationAccounts/agreements
CreatedTime : 3/26/2016 6:43:52 PM
ChangedTime : 3/26/2016 6:43:52 PM
AgreementType : X12
HostPartner : HostPartner
GuestPartner : GuestPartner
HostIdentityQualifier : AA
HostIdentityValue : AA
GuestIdentityQualifier : BB
GuestIdentityValue : BB
Content : {"AS2":null,"X12":{"ReceiveAgreement":{"SenderBusinessIdentity":{"Qualifier":"AA","Value":"AA"},"ReceiverBusinessIdentity":{"Qualifier":"ZZ","Valu
e":"ZZ"},"ProtocolSettings":{"ValidationSettings":{"ValidateCharacterSet":true,"CheckDuplicateInterchangeControlNumber":false,"InterchangeControlN
. . .This command creates an integration account agreement in the specified Azure resource group.
Parameters
-AgreementContent
Specifies agreement content, in JavaScript Object Notation (JSON) format, for the agreement. Specify either this parameter or the AgreementContentFilePath parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AgreementContentFilePath
Specifies the file path of agreement content for the agreement. Specify either this parameter or the AgreementContent parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AgreementName
Specifies a name for the integration account agreement.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AgreementType
Specifies the integration account agreement type. The acceptable values for this parameter are:
- X12
- AS2
- Edifact
| Type: | String |
| Accepted values: | X12, AS2, Edifact |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| 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 |
-GuestIdentityQualifier
Specifies a name business identity qualifier for the guest partner.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GuestIdentityQualifierValue
The integration account agreement guest identity qualifier value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-GuestPartner
Specifies the name of the guest partner.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostIdentityQualifier
Specifies a name business identity qualifier for the host partner.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostIdentityQualifierValue
The integration account agreement host identity qualifier value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HostPartner
Specifies the name of the host partner.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Metadata
Specifies a metadata object for the agreement.
| Type: | Object |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of the integration account.
| Type: | String |
| Aliases: | IntegrationAccountName, ResourceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifies the name of a resource group.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |