Compartilhar via

Set-AzEventHubApplicationGroup

Módulo:
Az.EventHub Module

Define um grupo de aplicativos eventHub

Sintaxe

SetExpanded (Default) 

Set-AzEventHubApplicationGroup
    -Name <String>
    -NamespaceName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-ClientAppGroupIdentifier <String>]
    [-IsEnabled]
    [-Policy <IApplicationGroupPolicy[]>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetViaIdentityExpanded 

Set-AzEventHubApplicationGroup
    -InputObject <IEventHubIdentity>
    [-ClientAppGroupIdentifier <String>]
    [-IsEnabled]
    [-Policy <IApplicationGroupPolicy[]>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Define um grupo de aplicativos eventHub

Exemplos

Exemplo 1: adicionar políticas de limitação a um grupo de aplicativos

$t3 = New-AzEventHubThrottlingPolicyConfig -Name t3 -MetricId OutgoingMessages -RateLimitThreshold 12000
$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup
$appGroup.Policy += $t3
Set-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup -Policy $appGroup.Policy

ClientAppGroupIdentifier     : NamespaceSASKeyName=a
Id                           : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/
                               myAppGroup
IsEnabled                    : True
Location                     : Central US
Name                         : myAppGroup
Policy                       : {{
                                 "name": "t1",
                                 "type": "ThrottlingPolicy",
                                 "rateLimitThreshold": 10000,
                                 "metricId": "IncomingMessages"
                               }, {
                                 "name": "t2",
                                 "type": "ThrottlingPolicy",
                                 "rateLimitThreshold": 20000,
                                 "metricId": "OutgoingBytes"
                               }, {
                                 "name": "t3",
                                 "type": "ThrottlingPolicy",
                                 "rateLimitThreshold": 12000,
                                 "metricId": "OutgoingMessages"
                               }}
ResourceGroupName            : myResourceGroup

-Policy usa uma matriz de objetos Policy. Ele representa todo o conjunto de políticas de limitação definidas no grupo de aplicativos e não apenas uma. Se você quiser adicionar ou remover políticas de limitação, a maneira certa de fazer isso é obter o grupo de aplicativos e consultar o membro de dados de política do objeto retornado, conforme mostrado acima.

Exemplo 2: atualizar o grupo de aplicativos usando o conjunto de parâmetros InputObject

$appGroup = Get-AzEventHubApplicationGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myAppGroup
Set-AzEventHubApplicationGroup -InputObject $appGroup -IsEnabled:$false

ClientAppGroupIdentifier     : NamespaceSASKeyName=a
Id                           : /subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/applicationGroups/
                               myAppGroup
IsEnabled                    : False
Location                     : Central US
Name                         : myAppGroup
Policy                       : {{
                                 "name": "t1",
                                 "type": "ThrottlingPolicy",
                                 "rateLimitThreshold": 10000,
                                 "metricId": "IncomingMessages"
                               }, {
                                 "name": "t2",
                                 "type": "ThrottlingPolicy",
                                 "rateLimitThreshold": 20000,
                                 "metricId": "OutgoingBytes"
                               }, {
                                 "name": "t3",
                                 "type": "ThrottlingPolicy",
                                 "rateLimitThreshold": 12000,
                                 "metricId": "OutgoingMessages"
                               }}
ResourceGroupName            : myResourceGroup

Desabilita o grupo de aplicativos myAppGroup.

Parâmetros

-AsJob

Executar o comando como um trabalho

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ClientAppGroupIdentifier

O identificador exclusivo do grupo de aplicativos. Dá suporte a SAS(SASKeyName=KeyName) ou AAD(AADAppID=Guid)

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para a comunicação com o Azure.

Propriedades do parâmetro

Tipo:PSObject
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

Parâmetro de identidade. Para construir, consulte a seção NOTES para propriedades INPUTOBJECT e crie uma tabela de hash.

Propriedades do parâmetro

Tipo:IEventHubIdentity
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetViaIdentityExpanded
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IsEnabled

Determina se o Grupo de Aplicativos tem permissão para criar conexão com o namespace ou não. Depois que o isEnabled for definido como false, todas as conexões existentes do grupo de aplicativos serão descartadas e nenhuma nova conexão será permitida

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Name

O nome do Grupo de Aplicativos.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:ApplicationGroupName

Conjuntos de parâmetros

SetExpanded
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-NamespaceName

O nome do namespace do EventHub

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetExpanded
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-NoWait

Execute o comando de forma assíncrona

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Policy

Lista de políticas de grupo que definem o comportamento do grupo de aplicativos. As políticas podem dar suporte a cenários de governança de recursos, como limitar o tráfego de entrada ou saída.

Propriedades do parâmetro

Tipo:

IApplicationGroupPolicy[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ResourceGroupName

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetExpanded
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SubscriptionId

A ID da assinatura de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:(Get-AzContext).Subscription.Id
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SetExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

IApplicationGroupPolicy

IEventHubIdentity

SwitchParameter

String

Saídas

IApplicationGroup