Partilhar via


Update-AzEventGridClient

Atualize um cliente com os parâmetros especificados.

Sintaxe

UpdateExpanded (Padrão)

Update-AzEventGridClient
    -Name <String>
    -NamespaceName <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-Attribute <Hashtable>]
    [-AuthenticationName <String>]
    [-CertificateSubjectCommonName <String>]
    [-CertificateSubjectCountryCode <String>]
    [-CertificateSubjectOrganization <String>]
    [-CertificateSubjectOrganizationUnit <String>]
    [-CertificateThumbprintPrimary <String>]
    [-CertificateThumbprintSecondary <String>]
    [-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
    [-ClientCertificateAuthenticationValidationScheme <String>]
    [-Description <String>]
    [-State <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityNamespaceExpanded

Update-AzEventGridClient
    -Name <String>
    -NamespaceInputObject <IEventGridIdentity>
    [-Attribute <Hashtable>]
    [-AuthenticationName <String>]
    [-CertificateSubjectCommonName <String>]
    [-CertificateSubjectCountryCode <String>]
    [-CertificateSubjectOrganization <String>]
    [-CertificateSubjectOrganizationUnit <String>]
    [-CertificateThumbprintPrimary <String>]
    [-CertificateThumbprintSecondary <String>]
    [-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
    [-ClientCertificateAuthenticationValidationScheme <String>]
    [-Description <String>]
    [-State <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-AzEventGridClient
    -InputObject <IEventGridIdentity>
    [-Attribute <Hashtable>]
    [-AuthenticationName <String>]
    [-CertificateSubjectCommonName <String>]
    [-CertificateSubjectCountryCode <String>]
    [-CertificateSubjectOrganization <String>]
    [-CertificateSubjectOrganizationUnit <String>]
    [-CertificateThumbprintPrimary <String>]
    [-CertificateThumbprintSecondary <String>]
    [-ClientCertificateAuthenticationAllowedThumbprint <String[]>]
    [-ClientCertificateAuthenticationValidationScheme <String>]
    [-Description <String>]
    [-State <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Descrição

Atualize um cliente com os parâmetros especificados.

Exemplos

Exemplo 1: Crie um cliente com os parâmetros especificados.

$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
Update-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid -Attribute $attribute -Description "This is a test client"
Name        ResourceGroupName
----        -----------------
azps-client azps_test_group_eventgrid

Crie um cliente com os parâmetros especificados.

Exemplo 2: Crie um cliente com os parâmetros especificados.

$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
$client = Get-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid
Update-AzEventGridClient -InputObject $client -Attribute $attribute -Description "This is a test client"
Name        ResourceGroupName
----        -----------------
azps-client azps_test_group_eventgrid

Crie um cliente com os parâmetros especificados.

Exemplo 3: Crie um cliente com os parâmetros especificados.

$attribute = @{"room"="345";"floor"="3";"deviceTypes"="AC"}
$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Update-AzEventGridClient -Name azps-client -NamespaceInputObject $namespace -Attribute $attribute -Description "This is a test client"
Name        ResourceGroupName
----        -----------------
azps-client azps_test_group_eventgrid

Crie um cliente com os parâmetros especificados.

Parâmetros

-AsJob

Executar o comando como um trabalho

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Attribute

Atributos para o cliente. Os valores suportados são int, bool, string, string[]. Exemplo:"attributes": { "room": "345", "floor": 12, "deviceTypes": ["Fan", "Light"] }

Propriedades dos parâmetros

Tipo:Hashtable
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-AuthenticationName

O nome apresentado pelo cliente para autenticação. O valor padrão é o nome do recurso.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateSubjectCommonName

O campo de nome comum no nome do assunto. O limite permitido é de 64 caracteres e deve ser especificado.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateSubjectCountryCode

O campo do código do país no nome do assunto. Se existir, o código do país deve ser representado por um código de duas letras definido na norma ISO 2166-1 (alfa-2). Por exemplo: "EUA".

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateSubjectOrganization

O campo da organização no nome do assunto. Se presente, o limite permitido é de 64 caracteres.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateSubjectOrganizationUnit

O campo da unidade organizacional no nome do assunto. Se presente, o limite permitido é de 32 caracteres.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateThumbprintPrimary

A impressão digital primária usada para validação.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-CertificateThumbprintSecondary

A impressão digital secundária usada para validação.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-ClientCertificateAuthenticationAllowedThumbprint

A lista de impressões digitais permitidas durante a autenticação do cliente. Esta propriedade é necessária somente se o validationScheme for 'ThumbprintMatch'.

Propriedades dos parâmetros

Tipo:

String[]

Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-ClientCertificateAuthenticationValidationScheme

O esquema de validação usado para autenticar o cliente. O valor padrão é SubjectMatchesAuthenticationName.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:Cf.

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

O parâmetro DefaultProfile não é funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Propriedades dos parâmetros

Tipo:PSObject
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Description

Descrição do recurso Cliente.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-InputObject

Parâmetro de identidade

Propriedades dos parâmetros

Tipo:IEventGridIdentity
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateViaIdentityExpanded
Posição:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Name

O nome do cliente.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:Nome do Cliente

Conjuntos de parâmetros

UpdateExpanded
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False
UpdateViaIdentityNamespaceExpanded
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-NamespaceInputObject

Parâmetro de identidade

Propriedades dos parâmetros

Tipo:IEventGridIdentity
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateViaIdentityNamespaceExpanded
Posição:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-NamespaceName

Nome do namespace.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateExpanded
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-NoWait

Execute o comando de forma assíncrona

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

O nome do grupo de recursos dentro da assinatura do usuário.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:Grupo de Recursos

Conjuntos de parâmetros

UpdateExpanded
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-State

Indica se o cliente está habilitado ou não. O valor padrão é Enabled.

Propriedades dos parâmetros

Tipo:String
Valor padrão:None
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-SubscriptionId

Credenciais de assinatura que identificam exclusivamente uma assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

Propriedades dos parâmetros

Tipo:String
Valor padrão:(Get-AzContext).Subscription.Id
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

UpdateExpanded
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por 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 dos parâmetros

Tipo:SwitchParameter
Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:Wi

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por 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

IEventGridIdentity

Saídas

IClient