Share via

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

Module:
Microsoft.Graph.Beta.Identity.DirectoryManagement Module

Update the properties of a certificateBasedAuthPki object.

Note

To view the v1.0 release of this cmdlet, view Update-MgDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

Syntax

UpdateExpanded (Default) 

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

    -CertificateBasedAuthPkiId <string>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-CertificateAuthorities <IMicrosoftGraphCertificateAuthorityDetail[]>]
    [-DeletedDateTime <datetime>]
    [-DisplayName <string>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-Status <string>]
    [-StatusDetails <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update 

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

    -CertificateBasedAuthPkiId <string>
    -BodyParameter <IMicrosoftGraphCertificateBasedAuthPki>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded 

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

    -InputObject <IIdentityDirectoryManagementIdentity>
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-CertificateAuthorities <IMicrosoftGraphCertificateAuthorityDetail[]>]
    [-DeletedDateTime <datetime>]
    [-DisplayName <string>]
    [-Id <string>]
    [-LastModifiedDateTime <datetime>]
    [-Status <string>]
    [-StatusDetails <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity 

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

    -InputObject <IIdentityDirectoryManagementIdentity>
    -BodyParameter <IMicrosoftGraphCertificateBasedAuthPki>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the properties of a certificateBasedAuthPki object.

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) PublicKeyInfrastructure.ReadWrite.All,
Delegated (personal Microsoft account) Not supported
Application PublicKeyInfrastructure.ReadWrite.All,

Examples

Example 1: Code snippet


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

$params = @{
	displayName = "Contoso PKI"
}

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration -CertificateBasedAuthPkiId $certificateBasedAuthPkiId -BodyParameter $params

This example shows how to use the Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

certificateBasedAuthPki To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCertificateBasedAuthPki
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CertificateAuthorities

The collection of certificate authorities contained in this public key infrastructure resource. To construct, see NOTES section for CERTIFICATEAUTHORITIES properties and create a hash table.

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCertificateAuthorityDetail[]

Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CertificateBasedAuthPkiId

The unique identifier of certificateBasedAuthPki

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeletedDateTime

Date and time when this object was deleted. Always null when the object hasn't been deleted.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayName

The name of the object. Maximum length is 256 characters.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.Beta.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Parameter properties

Type:Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentity
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-LastModifiedDateTime

The date and time when the object was created or last modified.

Parameter properties

Type:System.DateTime
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Status

The status of any asynchronous jobs runs on the object which can be upload or delete.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StatusDetails

The status details of the upload/deleted operation of PKI (Public Key Infrastructure).

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

{{ Fill in the Description }}

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCertificateBasedAuthPki

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCertificateBasedAuthPki

{{ Fill in the Description }}

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IMicrosoftGraphCertificateBasedAuthPki>: certificateBasedAuthPki [(Any) <Object>]: This indicates any property can be added to this object. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted. [Id <String>]: The unique identifier for an entity. Read-only. [CertificateAuthorities <IMicrosoftGraphCertificateAuthorityDetail[]>]: The collection of certificate authorities contained in this public key infrastructure resource. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted. [Id <String>]: The unique identifier for an entity. Read-only. [Certificate <Byte[]>]: The public key of the certificate authority. [CertificateAuthorityType <String>]: certificateAuthorityType [CertificateRevocationListUrl <String>]: The URL to check if the certificate is revoked. [CreatedDateTime <DateTime?>]: The date and time when the certificate authority was created. [DeltaCertificateRevocationListUrl <String>]: [DisplayName <String>]: The display name of the certificate authority. [ExpirationDateTime <DateTime?>]: The date and time when the certificate authority expires. Supports $filter (eq) and $orderby. [IsIssuerHintEnabled <Boolean?>]: Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is false. Optional. [Issuer <String>]: The issuer of the certificate authority. [IssuerSubjectKeyIdentifier <String>]: The subject key identifier of certificate authority. [Thumbprint <String>]: The thumbprint of certificate authority certificate. Supports $filter (eq, startswith). [DisplayName <String>]: The name of the object. Maximum length is 256 characters. [LastModifiedDateTime <DateTime?>]: The date and time when the object was created or last modified. [Status <String>]: The status of any asynchronous jobs runs on the object which can be upload or delete. [StatusDetails <String>]: The status details of the upload/deleted operation of PKI (Public Key Infrastructure).

CERTIFICATEAUTHORITIES <IMicrosoftGraphCertificateAuthorityDetail[]>: The collection of certificate authorities contained in this public key infrastructure resource. [DeletedDateTime <DateTime?>]: Date and time when this object was deleted. Always null when the object hasn't been deleted. [Id <String>]: The unique identifier for an entity. Read-only. [Certificate <Byte[]>]: The public key of the certificate authority. [CertificateAuthorityType <String>]: certificateAuthorityType [CertificateRevocationListUrl <String>]: The URL to check if the certificate is revoked. [CreatedDateTime <DateTime?>]: The date and time when the certificate authority was created. [DeltaCertificateRevocationListUrl <String>]: [DisplayName <String>]: The display name of the certificate authority. [ExpirationDateTime <DateTime?>]: The date and time when the certificate authority expires. Supports $filter (eq) and $orderby. [IsIssuerHintEnabled <Boolean?>]: Indicates whether the certificate picker presents the certificate authority to the user to use for authentication. Default value is false. Optional. [Issuer <String>]: The issuer of the certificate authority. [IssuerSubjectKeyIdentifier <String>]: The subject key identifier of certificate authority. [Thumbprint <String>]: The thumbprint of certificate authority certificate. Supports $filter (eq, startswith).

INPUTOBJECT <IIdentityDirectoryManagementIdentity>: Identity Parameter [AdministrativeUnitId <String>]: The unique identifier of administrativeUnit [AllowedValueId <String>]: The unique identifier of allowedValue [AttributeSetId <String>]: The unique identifier of attributeSet [CertificateAuthorityAsEntityId <String>]: The unique identifier of certificateAuthorityAsEntity [CertificateAuthorityDetailId <String>]: The unique identifier of certificateAuthorityDetail [CertificateBasedApplicationConfigurationId <String>]: The unique identifier of certificateBasedApplicationConfiguration [CertificateBasedAuthPkiId <String>]: The unique identifier of certificateBasedAuthPki [CommandId <String>]: The unique identifier of command [CommerceSubscriptionId <String>]: Alternate key of companySubscription [CompanySubscriptionId <String>]: The unique identifier of companySubscription [ContractId <String>]: The unique identifier of contract [CustomSecurityAttributeDefinitionId <String>]: The unique identifier of customSecurityAttributeDefinition [DeviceId <String>]: The unique identifier of device [DeviceLocalCredentialInfoId <String>]: The unique identifier of deviceLocalCredentialInfo [DeviceTemplateId <String>]: The unique identifier of deviceTemplate [DirectoryObjectId <String>]: The unique identifier of directoryObject [DirectoryRoleId <String>]: The unique identifier of directoryRole [DirectoryRoleTemplateId <String>]: The unique identifier of directoryRoleTemplate [DirectorySettingId <String>]: The unique identifier of directorySetting [DirectorySettingTemplateId <String>]: The unique identifier of directorySettingTemplate [DomainDnsRecordId <String>]: The unique identifier of domainDnsRecord [DomainId <String>]: The unique identifier of domain [DomainName <String>]: Usage: domainName='{domainName}' [ExtensionId <String>]: The unique identifier of extension [ExternalUserProfileId <String>]: The unique identifier of externalUserProfile [FeatureRolloutPolicyId <String>]: The unique identifier of featureRolloutPolicy [HardwareOathTokenAuthenticationMethodDeviceId <String>]: The unique identifier of hardwareOathTokenAuthenticationMethodDevice [IdentityProviderBaseId <String>]: The unique identifier of identityProviderBase [ImpactedResourceId <String>]: The unique identifier of impactedResource [InboundSharedUserProfileUserId <String>]: The unique identifier of inboundSharedUserProfile [InternalDomainFederationId <String>]: The unique identifier of internalDomainFederation [MutualTlsOauthConfigurationId <String>]: The unique identifier of mutualTlsOauthConfiguration [OcpSubscriptionId <String>]: Alternate key of companySubscription [OnPremisesDirectorySynchronizationId <String>]: The unique identifier of onPremisesDirectorySynchronization [OrgContactId <String>]: The unique identifier of orgContact [OrganizationId <String>]: The unique identifier of organization [OrganizationalBrandingLocalizationId <String>]: The unique identifier of organizationalBrandingLocalization [OutboundSharedUserProfileUserId <String>]: The unique identifier of outboundSharedUserProfile [PendingExternalUserProfileId <String>]: The unique identifier of pendingExternalUserProfile [ProfileCardPropertyId <String>]: The unique identifier of profileCardProperty [ProfilePropertySettingId <String>]: The unique identifier of profilePropertySetting [ProfileSourceId <String>]: The unique identifier of profileSource [RecommendationId <String>]: The unique identifier of recommendation [RoleTemplateId <String>]: Alternate key of directoryRole [ScopedRoleMembershipId <String>]: The unique identifier of scopedRoleMembership [SharedEmailDomainId <String>]: The unique identifier of sharedEmailDomain [SharedEmailDomainInvitationId <String>]: The unique identifier of sharedEmailDomainInvitation [SourceId <String>]: Alternate key of profileSource [SubscribedSkuId <String>]: The unique identifier of subscribedSku [TenantId <String>]: Usage: tenantId='{tenantId}' [TenantReferenceTenantId <String>]: The unique identifier of tenantReference [UsageRightId <String>]: The unique identifier of usageRight [UserId <String>]: The unique identifier of user