azure.mgmt.keyvault package
Module contents
- class azure.mgmt.keyvault.KeyVaultManagementClient(credential: TokenCredential, subscription_id: str, api_version: str | None = None, base_url: str = 'https://management.azure.com', profile: KnownProfiles = KnownProfiles.default, **kwargs: Any)[source]
Bases:
MultiApiClientMixin,_SDKClientThe Azure management API provides a RESTful set of web services that interact with Azure Key Vault.
This ready contains multiple API versions, to help you deal with all of the Azure clouds (Azure Stack, Azure Government, Azure China, etc.). By default, it uses the latest API version available on public Azure. For production, you should stick to a particular api-version and/or profile. The profile sets a mapping between an operation group and its API version. The api-version parameter sets the default API version if the operation group is not described in the profile.
- Parameters:
credential (TokenCredential) – Credential needed for the client to connect to Azure. Required.
subscription_id (str) – Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. Required.
api_version (str) – API version to use if no profile is provided, or if missing in profile.
base_url (str) – Service URL
profile (azure.profiles.KnownProfiles) – A profile definition, from KnownProfiles to dict.
- Keyword Arguments:
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.
This is a fake class to support current implemetation of MultiApiClientMixin.” Will be removed in final version of multiapi azure-core based client
- classmethod models(api_version='2024-11-01')[source]
Module depends on the API version:
2016-10-01:
v2016_10_01.models2023-02-01:
v2023_02_01.models2024-11-01:
v2024_11_01.models
- DEFAULT_API_VERSION = '2024-11-01'
- LATEST_PROFILE = azure.mgmt.keyvault.KeyVaultManagementClient latest
- property keys
Instance depends on the API version:
2023-02-01:
KeysOperations2024-11-01:
KeysOperations
- property managed_hsm_keys
Instance depends on the API version:
2023-02-01:
ManagedHsmKeysOperations2024-11-01:
ManagedHsmKeysOperations
- property managed_hsms
Instance depends on the API version:
2023-02-01:
ManagedHsmsOperations2024-11-01:
ManagedHsmsOperations
- property mhsm_private_endpoint_connections
Instance depends on the API version:
2023-02-01:
MHSMPrivateEndpointConnectionsOperations2024-11-01:
MHSMPrivateEndpointConnectionsOperations
- property mhsm_private_link_resources
Instance depends on the API version:
2023-02-01:
MHSMPrivateLinkResourcesOperations2024-11-01:
MHSMPrivateLinkResourcesOperations
- property mhsm_regions
Instance depends on the API version:
2023-02-01:
MHSMRegionsOperations2024-11-01:
MHSMRegionsOperations
- property operations
Instance depends on the API version:
2016-10-01:
Operations2023-02-01:
Operations2024-11-01:
Operations
- property private_endpoint_connections
Instance depends on the API version:
2023-02-01:
PrivateEndpointConnectionsOperations2024-11-01:
PrivateEndpointConnectionsOperations
- property private_link_resources
Instance depends on the API version:
2023-02-01:
PrivateLinkResourcesOperations2024-11-01:
PrivateLinkResourcesOperations
- property secrets
Instance depends on the API version:
2023-02-01:
SecretsOperations2024-11-01:
SecretsOperations
- property vaults
Instance depends on the API version:
2016-10-01:
VaultsOperations2023-02-01:
VaultsOperations2024-11-01:
VaultsOperations
Submodules
- azure.mgmt.keyvault.v2024_11_01 package
- Submodules
- azure.mgmt.keyvault.v2024_11_01.models module
AccessPolicyEntryAccessPolicyUpdateKindActionActionsRequiredActivationStatusAttributesCertificatePermissionsCertificatePermissions.ALLCertificatePermissions.BACKUPCertificatePermissions.CREATECertificatePermissions.DELETECertificatePermissions.DELETEISSUERSCertificatePermissions.GETCertificatePermissions.GETISSUERSCertificatePermissions.IMPORTCertificatePermissions.IMPORT_ENUMCertificatePermissions.LISTCertificatePermissions.LISTISSUERSCertificatePermissions.MANAGECONTACTSCertificatePermissions.MANAGEISSUERSCertificatePermissions.PURGECertificatePermissions.RECOVERCertificatePermissions.RESTORECertificatePermissions.SETISSUERSCertificatePermissions.UPDATE
CheckMhsmNameAvailabilityParametersCheckMhsmNameAvailabilityResultCheckNameAvailabilityResultCloudErrorBodyCreateModeDeletedManagedHsmDeletedManagedHsmListResultDeletedManagedHsmPropertiesDeletedVaultDeletedVaultListResultDeletedVaultPropertiesDeletionRecoveryLevelDimensionPropertiesErrorGeoReplicationRegionProvisioningStateIPRuleIdentityTypeJsonWebKeyCurveNameJsonWebKeyOperationJsonWebKeyTypeKeyKeyAttributesKeyCreateParametersKeyListResultKeyPermissionsKeyPermissions.ALLKeyPermissions.BACKUPKeyPermissions.CREATEKeyPermissions.DECRYPTKeyPermissions.DELETEKeyPermissions.ENCRYPTKeyPermissions.GETKeyPermissions.GETROTATIONPOLICYKeyPermissions.IMPORTKeyPermissions.IMPORT_ENUMKeyPermissions.LISTKeyPermissions.PURGEKeyPermissions.RECOVERKeyPermissions.RELEASEKeyPermissions.RESTOREKeyPermissions.ROTATEKeyPermissions.SETROTATIONPOLICYKeyPermissions.SIGNKeyPermissions.UNWRAP_KEYKeyPermissions.UPDATEKeyPermissions.VERIFYKeyPermissions.WRAP_KEY
KeyPropertiesKeyReleasePolicyKeyRotationPolicyActionTypeKeyRotationPolicyAttributesLifetimeActionLogSpecificationMHSMGeoReplicatedRegionMHSMIPRuleMHSMNetworkRuleSetMHSMPrivateEndpointMHSMPrivateEndpointConnectionMHSMPrivateEndpointConnectionItemMHSMPrivateEndpointConnectionsListResultMHSMPrivateLinkResourceMHSMPrivateLinkResourceListResultMHSMPrivateLinkServiceConnectionStateMHSMRegionsListResultMHSMVirtualNetworkRuleManagedHSMSecurityDomainPropertiesManagedHsmManagedHsmActionManagedHsmErrorManagedHsmKeyManagedHsmKeyAttributesManagedHsmKeyCreateParametersManagedHsmKeyListResultManagedHsmKeyPropertiesManagedHsmKeyReleasePolicyManagedHsmKeyRotationPolicyAttributesManagedHsmLifetimeActionManagedHsmListResultManagedHsmPropertiesManagedHsmResourceManagedHsmRotationPolicyManagedHsmSkuManagedHsmSkuFamilyManagedHsmSkuNameManagedHsmTriggerManagedServiceIdentityManagedServiceIdentityTypeMetricSpecificationNetworkRuleActionNetworkRuleBypassOptionsNetworkRuleSetOperationOperationDisplayOperationListResultPermissionsPrivateEndpointPrivateEndpointConnectionPrivateEndpointConnectionItemPrivateEndpointConnectionListResultPrivateEndpointConnectionProvisioningStatePrivateEndpointConnectionProvisioningState.CREATINGPrivateEndpointConnectionProvisioningState.DELETINGPrivateEndpointConnectionProvisioningState.DISCONNECTEDPrivateEndpointConnectionProvisioningState.FAILEDPrivateEndpointConnectionProvisioningState.SUCCEEDEDPrivateEndpointConnectionProvisioningState.UPDATING
PrivateEndpointServiceConnectionStatusPrivateLinkResourcePrivateLinkResourceListResultPrivateLinkServiceConnectionStateProvisioningStateProxyResourceWithoutSystemDataPublicNetworkAccessReasonResourceResourceListResultRotationPolicySecretSecretAttributesSecretCreateOrUpdateParametersSecretListResultSecretPatchParametersSecretPatchPropertiesSecretPermissionsSecretPropertiesServiceSpecificationSkuSkuFamilySkuNameStoragePermissionsStoragePermissions.ALLStoragePermissions.BACKUPStoragePermissions.DELETEStoragePermissions.DELETESASStoragePermissions.GETStoragePermissions.GETSASStoragePermissions.LISTStoragePermissions.LISTSASStoragePermissions.PURGEStoragePermissions.RECOVERStoragePermissions.REGENERATEKEYStoragePermissions.RESTOREStoragePermissions.SETStoragePermissions.SETSASStoragePermissions.UPDATE
SystemDataTriggerUserAssignedIdentityVaultVaultAccessPolicyParametersVaultAccessPolicyPropertiesVaultCheckNameAvailabilityParametersVaultCreateOrUpdateParametersVaultListResultVaultPatchParametersVaultPatchPropertiesVaultPropertiesVaultProvisioningStateVirtualNetworkRule
- azure.mgmt.keyvault.v2024_11_01.operations module
KeysOperationsMHSMPrivateEndpointConnectionsOperationsMHSMPrivateLinkResourcesOperationsMHSMRegionsOperationsManagedHsmKeysOperationsManagedHsmsOperationsManagedHsmsOperations.begin_create_or_update()ManagedHsmsOperations.begin_delete()ManagedHsmsOperations.begin_purge_deleted()ManagedHsmsOperations.begin_update()ManagedHsmsOperations.check_mhsm_name_availability()ManagedHsmsOperations.get()ManagedHsmsOperations.get_deleted()ManagedHsmsOperations.list_by_resource_group()ManagedHsmsOperations.list_by_subscription()ManagedHsmsOperations.list_deleted()ManagedHsmsOperations.models
OperationsPrivateEndpointConnectionsOperationsPrivateLinkResourcesOperationsSecretsOperationsVaultsOperations
- azure.mgmt.keyvault.v2024_11_01.models module
- Module contents
- Submodules
- azure.mgmt.keyvault.v2023_02_01 package
- Submodules
- azure.mgmt.keyvault.v2023_02_01.models module
AccessPolicyEntryAccessPolicyUpdateKindActionActionsRequiredActivationStatusAttributesCertificatePermissionsCertificatePermissions.ALLCertificatePermissions.BACKUPCertificatePermissions.CREATECertificatePermissions.DELETECertificatePermissions.DELETEISSUERSCertificatePermissions.GETCertificatePermissions.GETISSUERSCertificatePermissions.IMPORTCertificatePermissions.IMPORT_ENUMCertificatePermissions.LISTCertificatePermissions.LISTISSUERSCertificatePermissions.MANAGECONTACTSCertificatePermissions.MANAGEISSUERSCertificatePermissions.PURGECertificatePermissions.RECOVERCertificatePermissions.RESTORECertificatePermissions.SETISSUERSCertificatePermissions.UPDATE
CheckMhsmNameAvailabilityParametersCheckMhsmNameAvailabilityResultCheckNameAvailabilityResultCloudErrorBodyCreateModeDeletedManagedHsmDeletedManagedHsmListResultDeletedManagedHsmPropertiesDeletedVaultDeletedVaultListResultDeletedVaultPropertiesDeletionRecoveryLevelDimensionPropertiesErrorGeoReplicationRegionProvisioningStateIPRuleIdentityTypeJsonWebKeyCurveNameJsonWebKeyOperationJsonWebKeyTypeKeyKeyAttributesKeyCreateParametersKeyListResultKeyPermissionsKeyPermissions.ALLKeyPermissions.BACKUPKeyPermissions.CREATEKeyPermissions.DECRYPTKeyPermissions.DELETEKeyPermissions.ENCRYPTKeyPermissions.GETKeyPermissions.GETROTATIONPOLICYKeyPermissions.IMPORTKeyPermissions.IMPORT_ENUMKeyPermissions.LISTKeyPermissions.PURGEKeyPermissions.RECOVERKeyPermissions.RELEASEKeyPermissions.RESTOREKeyPermissions.ROTATEKeyPermissions.SETROTATIONPOLICYKeyPermissions.SIGNKeyPermissions.UNWRAP_KEYKeyPermissions.UPDATEKeyPermissions.VERIFYKeyPermissions.WRAP_KEY
KeyPropertiesKeyReleasePolicyKeyRotationPolicyActionTypeKeyRotationPolicyAttributesLifetimeActionLogSpecificationMHSMGeoReplicatedRegionMHSMIPRuleMHSMNetworkRuleSetMHSMPrivateEndpointMHSMPrivateEndpointConnectionMHSMPrivateEndpointConnectionItemMHSMPrivateEndpointConnectionsListResultMHSMPrivateLinkResourceMHSMPrivateLinkResourceListResultMHSMPrivateLinkServiceConnectionStateMHSMRegionsListResultMHSMVirtualNetworkRuleManagedHSMSecurityDomainPropertiesManagedHsmManagedHsmActionManagedHsmErrorManagedHsmKeyManagedHsmKeyAttributesManagedHsmKeyCreateParametersManagedHsmKeyListResultManagedHsmKeyPropertiesManagedHsmKeyReleasePolicyManagedHsmKeyRotationPolicyAttributesManagedHsmLifetimeActionManagedHsmListResultManagedHsmPropertiesManagedHsmResourceManagedHsmRotationPolicyManagedHsmSkuManagedHsmSkuFamilyManagedHsmSkuNameManagedHsmTriggerMetricSpecificationNetworkRuleActionNetworkRuleBypassOptionsNetworkRuleSetOperationOperationDisplayOperationListResultPermissionsPrivateEndpointPrivateEndpointConnectionPrivateEndpointConnectionItemPrivateEndpointConnectionListResultPrivateEndpointConnectionProvisioningStatePrivateEndpointConnectionProvisioningState.CREATINGPrivateEndpointConnectionProvisioningState.DELETINGPrivateEndpointConnectionProvisioningState.DISCONNECTEDPrivateEndpointConnectionProvisioningState.FAILEDPrivateEndpointConnectionProvisioningState.SUCCEEDEDPrivateEndpointConnectionProvisioningState.UPDATING
PrivateEndpointServiceConnectionStatusPrivateLinkResourcePrivateLinkResourceListResultPrivateLinkServiceConnectionStateProvisioningStateProxyResourceWithoutSystemDataPublicNetworkAccessReasonResourceResourceListResultRotationPolicySecretSecretAttributesSecretCreateOrUpdateParametersSecretListResultSecretPatchParametersSecretPatchPropertiesSecretPermissionsSecretPropertiesServiceSpecificationSkuSkuFamilySkuNameStoragePermissionsStoragePermissions.ALLStoragePermissions.BACKUPStoragePermissions.DELETEStoragePermissions.DELETESASStoragePermissions.GETStoragePermissions.GETSASStoragePermissions.LISTStoragePermissions.LISTSASStoragePermissions.PURGEStoragePermissions.RECOVERStoragePermissions.REGENERATEKEYStoragePermissions.RESTOREStoragePermissions.SETStoragePermissions.SETSASStoragePermissions.UPDATE
SystemDataTriggerVaultVaultAccessPolicyParametersVaultAccessPolicyPropertiesVaultCheckNameAvailabilityParametersVaultCreateOrUpdateParametersVaultListResultVaultPatchParametersVaultPatchPropertiesVaultPropertiesVaultProvisioningStateVirtualNetworkRule
- azure.mgmt.keyvault.v2023_02_01.operations module
KeysOperationsMHSMPrivateEndpointConnectionsOperationsMHSMPrivateLinkResourcesOperationsMHSMRegionsOperationsManagedHsmKeysOperationsManagedHsmsOperationsManagedHsmsOperations.begin_create_or_update()ManagedHsmsOperations.begin_delete()ManagedHsmsOperations.begin_purge_deleted()ManagedHsmsOperations.begin_update()ManagedHsmsOperations.check_mhsm_name_availability()ManagedHsmsOperations.get()ManagedHsmsOperations.get_deleted()ManagedHsmsOperations.list_by_resource_group()ManagedHsmsOperations.list_by_subscription()ManagedHsmsOperations.list_deleted()ManagedHsmsOperations.models
OperationsPrivateEndpointConnectionsOperationsPrivateLinkResourcesOperationsSecretsOperationsVaultsOperations
- azure.mgmt.keyvault.v2023_02_01.models module
- Module contents
- Submodules
- azure.mgmt.keyvault.v2016_10_01 package
- Submodules
- azure.mgmt.keyvault.v2016_10_01.models module
AccessPolicyEntryAccessPolicyUpdateKindCertificatePermissionsCertificatePermissions.CREATECertificatePermissions.DELETECertificatePermissions.DELETEISSUERSCertificatePermissions.GETCertificatePermissions.GETISSUERSCertificatePermissions.IMPORTCertificatePermissions.IMPORT_ENUMCertificatePermissions.LISTCertificatePermissions.LISTISSUERSCertificatePermissions.MANAGECONTACTSCertificatePermissions.MANAGEISSUERSCertificatePermissions.PURGECertificatePermissions.RECOVERCertificatePermissions.SETISSUERSCertificatePermissions.UPDATE
CheckNameAvailabilityResultCreateModeDeletedVaultDeletedVaultListResultDeletedVaultPropertiesKeyPermissionsKeyPermissions.BACKUPKeyPermissions.CREATEKeyPermissions.DECRYPTKeyPermissions.DELETEKeyPermissions.ENCRYPTKeyPermissions.GETKeyPermissions.IMPORTKeyPermissions.IMPORT_ENUMKeyPermissions.LISTKeyPermissions.PURGEKeyPermissions.RECOVERKeyPermissions.RESTOREKeyPermissions.SIGNKeyPermissions.UNWRAP_KEYKeyPermissions.UPDATEKeyPermissions.VERIFYKeyPermissions.WRAP_KEY
LogSpecificationOperationOperationDisplayOperationListResultPermissionsReasonResourceResourceListResultSecretPermissionsServiceSpecificationSkuSkuFamilySkuNameStoragePermissionsStoragePermissions.BACKUPStoragePermissions.DELETEStoragePermissions.DELETESASStoragePermissions.GETStoragePermissions.GETSASStoragePermissions.LISTStoragePermissions.LISTSASStoragePermissions.PURGEStoragePermissions.RECOVERStoragePermissions.REGENERATEKEYStoragePermissions.RESTOREStoragePermissions.SETStoragePermissions.SETSASStoragePermissions.UPDATE
VaultVaultAccessPolicyParametersVaultAccessPolicyPropertiesVaultCheckNameAvailabilityParametersVaultCreateOrUpdateParametersVaultListResultVaultPatchParametersVaultPatchPropertiesVaultProperties
- azure.mgmt.keyvault.v2016_10_01.operations module
- azure.mgmt.keyvault.v2016_10_01.models module
- Module contents
- Submodules