< Back

Set-AzureRmIntegrationAccountAgreement

Tue Jan 29, 2019 9:51 pm

NAME Set-AzureRmIntegrationAccountAgreement



SYNOPSIS

Modifies an integration account agreement.





SYNTAX

Set-AzureRmIntegrationAccountAgreement [-AgreementContent <String>] [-AgreementContentFilePath <String>] -AgreementName <String> [-AgreementType

{X12 | AS2 | Edifact}] [-DefaultProfile <IAzureContextContainer>] [-Force] [-GuestIdentityQualifier <String>] [-GuestIdentityQualifierValue

<String>] [-GuestPartner <String>] [-HostIdentityQualifier <String>] [-HostIdentityQualifierValue <String>] [-HostPartner <String>] [-Metadata

<Object>] -Name <String> -ResourceGroupName <String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Set-AzureRmIntegrationAccountAgreement cmdlet modifies an integration account agreement. This cmdlet returns an object that represents the

integration account agreement. Specify the integration account name, resource group name, and agreement name.



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.





PARAMETERS

-AgreementContent <String>

Specifies agreement content, in JavaScript Object Notation (JSON) format, for the agreement.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AgreementContentFilePath <String>

Specifies the file path of agreement content for the agreement.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-AgreementName <String>

Specifies the name of the integration account agreement.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-AgreementType <String>

Specifies the integration account agreement type. The acceptable values for this parameter are:



- X12



- AS2



- Edifact



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-GuestIdentityQualifier <String>

Specifies a name business identity qualifier for the guest partner.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-GuestIdentityQualifierValue <String>

The integration account agreement guest identity qualifier value.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-GuestPartner <String>

Specifies the name of the guest partner.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-HostIdentityQualifier <String>

Specifies a name business identity qualifier for the host partner.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-HostIdentityQualifierValue <String>

The integration account agreement host identity qualifier value.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-HostPartner <String>

Specifies the name of the host partner.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Metadata <Object>

Specifies a metadata object for the agreement.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of an integration account.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of a resource group.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Management.Logic.Models.IntegrationAccountAgreement







NOTES









Example 1: Update an integration account agreement



PS C:\\>Set-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/IntegrationAc

count31/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 updates an integration account agreement in the specified Azure resource group.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... tagreement

Get-AzureRmIntegrationAccountAgreement

New-AzureRmIntegrationAccountAgreement

Remove-AzureRmIntegrationAccountAgreement