Share via


Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration

Update the properties of a certificateBasedAuthPki object.

Syntax

Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration
      -CertificateBasedAuthPkiId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-CertificateAuthorities <IMicrosoftGraphCertificateAuthorityDetail[]>]
      [-DeletedDateTime <DateTime>]
      [-DisplayName <String>]
      [-Id <String>]
      [-LastModifiedDateTime <DateTime>]
      [-Status <String>]
      [-StatusDetails <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration
      -CertificateBasedAuthPkiId <String>
      -BodyParameter <IMicrosoftGraphCertificateBasedAuthPki>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration
      -InputObject <IIdentityDirectoryManagementIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-CertificateAuthorities <IMicrosoftGraphCertificateAuthorityDetail[]>]
      [-DeletedDateTime <DateTime>]
      [-DisplayName <String>]
      [-Id <String>]
      [-LastModifiedDateTime <DateTime>]
      [-Status <String>]
      [-StatusDetails <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaDirectoryPublicKeyInfrastructureCertificateBasedAuthConfiguration
      -InputObject <IIdentityDirectoryManagementIdentity>
      -BodyParameter <IMicrosoftGraphCertificateBasedAuthPki>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-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

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

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

Type:IMicrosoftGraphCertificateBasedAuthPki
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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.

Type:IMicrosoftGraphCertificateAuthorityDetail[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CertificateBasedAuthPkiId

The unique identifier of certificateBasedAuthPki

Type:String
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeletedDateTime

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

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

The unique identifier for an entity. Read-only.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:IIdentityDirectoryManagementIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LastModifiedDateTime

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

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-StatusDetails

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IIdentityDirectoryManagementIdentity

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCertificateBasedAuthPki

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphCertificateBasedAuthPki

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
  • [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
  • [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