Delen via


Certificate - Create Or Update

Hiermee maakt of werkt u het certificaat bij dat wordt gebruikt voor verificatie met de back-end.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}?api-version=2021-08-01

URI-parameters

Name In Vereist Type Description
certificateId
path True

string

Id van de certificaatentiteit. Moet uniek zijn in het huidige API Management service-exemplaar.

Regex-patroon: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

De naam van de resourcegroep.

serviceName
path True

string

De naam van de API Management service.

Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.

api-version
query True

string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Aanvraagkoptekst

Name Vereist Type Description
If-Match

string

ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name Type Description
properties.data

string

Base 64-gecodeerd certificaat met behulp van de weergave van de toepassing/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

KeyVault-locatiedetails van het certificaat.

properties.password

string

Wachtwoord voor het certificaat

Antwoorden

Name Type Description
200 OK

CertificateContract

De certificaatgegevens zijn bijgewerkt.

Kopteksten

ETag: string

201 Created

CertificateContract

Het nieuwe certificaat is toegevoegd.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateCertificate
ApiManagementCreateCertificateWithKeyVault

ApiManagementCreateCertificate

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert?api-version=2021-08-01

{
  "properties": {
    "data": "****************Base 64 Encoded Certificate *******************************",
    "password": "****Certificate Password******"
  }
}

Voorbeeldrespons

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/tempcert",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "tempcert",
  "properties": {
    "subject": "CN=contoso.com",
    "thumbprint": "*******************3",
    "expirationDate": "2018-03-17T21:55:07+00:00"
  }
}

ApiManagementCreateCertificateWithKeyVault

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv?api-version=2021-08-01

{
  "properties": {
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert"
    }
  }
}

Voorbeeldrespons

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "templateCertkv",
  "properties": {
    "subject": "CN=*.msitesting.net",
    "thumbprint": "EA**********************9AD690",
    "expirationDate": "2037-01-01T07:00:00Z",
    "keyVault": {
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
      }
    }
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/certificates",
  "name": "templateCertkv",
  "properties": {
    "subject": "CN=*.msitesting.net",
    "thumbprint": "EA**********************9AD690",
    "expirationDate": "2037-01-01T07:00:00Z",
    "keyVault": {
      "secretIdentifier": "https://rpbvtkeyvaultintegration.vault-int.azure-int.net/secrets/msitestingCert",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-22T00:24:53.3191468Z"
      }
    }
  }
}

Definities

Name Description
CertificateContract

Certificaatdetails.

CertificateCreateOrUpdateParameters

Details van certificaat maken of bijwerken.

ErrorFieldContract

Fout Veldcontract.

ErrorResponse

Foutreactie.

KeyVaultContractCreateProperties

Maak keyVault-contractgegevens.

KeyVaultContractProperties

KeyVault-contractgegevens.

KeyVaultLastAccessStatusContractProperties

Update-eigenschappen van contract uitgeven.

CertificateContract

Certificaatdetails.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.expirationDate

string

Vervaldatum van het certificaat. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.

properties.keyVault

KeyVaultContractProperties

KeyVault-locatiedetails van het certificaat.

properties.subject

string

Onderwerpkenmerk van het certificaat.

properties.thumbprint

string

Vingerafdruk van het certificaat.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

CertificateCreateOrUpdateParameters

Details van certificaat maken of bijwerken.

Name Type Description
properties.data

string

Base 64-gecodeerd certificaat met behulp van de weergave van de toepassing/x-pkcs12.

properties.keyVault

KeyVaultContractCreateProperties

KeyVault-locatiedetails van het certificaat.

properties.password

string

Wachtwoord voor het certificaat

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

KeyVaultContractCreateProperties

Maak keyVault-contractgegevens.

Name Type Description
identityClientId

string

Null voor SystemAssignedIdentity of Client-id voor UserAssignedIdentity , die wordt gebruikt voor toegang tot sleutelkluisgeheim.

secretIdentifier

string

Sleutelkluisgeheim-id voor het ophalen van het geheim. Het opgeven van een versiegeheim voorkomt automatisch vernieuwen. Hiervoor moet API Management service worden geconfigureerd met aka.ms/apimmsi

KeyVaultContractProperties

KeyVault-contractgegevens.

Name Type Description
identityClientId

string

Null voor SystemAssignedIdentity of Client-id voor UserAssignedIdentity , die wordt gebruikt voor toegang tot sleutelkluisgeheim.

lastStatus

KeyVaultLastAccessStatusContractProperties

Laatste synchronisatie- en vernieuwingsstatus van geheim uit sleutelkluis.

secretIdentifier

string

Sleutelkluisgeheim-id voor het ophalen van het geheim. Het opgeven van een versiegeheim voorkomt automatisch vernieuwen. Hiervoor moet API Management service worden geconfigureerd met aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Update-eigenschappen van contract uitgeven.

Name Type Description
code

string

Laatste statuscode voor synchronisatie en vernieuwing van geheim uit sleutelkluis.

message

string

Details van de fout zijn anders leeg.

timeStampUtc

string

De laatste keer dat het geheim is geopend. De datum voldoet aan de volgende notatie: yyyy-MM-ddTHH:mm:ssZ zoals opgegeven door de ISO 8601-standaard.