Workspace Certificate - Create Or Update

Referentie

Service:: API Management

API-versie:: 2024-05-01

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}/workspaces/{workspaceId}/certificates/{certificateId}?api-version=2024-05-01

URI-parameters

Name	In	Vereist	Type	Description
certificateId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Id van de certificaatentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Werkruimte-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

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 toepassing/x-pkcs12-weergave.
properties.keyVault	KeyVaultContractCreateProperties	Locatiedetails van KeyVault 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.

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 Flow.

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateWorkspaceCertificate

ApiManagementCreateWorkspaceCertificateWithKeyVault

ApiManagementCreateWorkspaceCertificate

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/tempcert?api-version=2024-05-01

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

Voorbeeldrespons

Statuscode:: 201

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

Statuscode:: 200

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

ApiManagementCreateWorkspaceCertificateWithKeyVault

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv?api-version=2024-05-01

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

Voorbeeldrespons

Statuscode:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/workspaces/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"
      }
    }
  }
}

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/certificates/templateCertkv",
  "type": "Microsoft.ApiManagement/service/workspaces/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	Certificaatgegevens.
CertificateCreateOrUpdateParameters	Details van certificaat maken of bijwerken.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
KeyVaultContractCreateProperties	Maak keyVault-contractgegevens.
KeyVaultContractProperties	KeyVault-contractgegevens.
KeyVaultLastAccessStatusContractProperties	Probleem met update-eigenschappen van contract.

CertificateContract

Object

Certificaatgegevens.

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 (date-time)	Vervaldatum van het certificaat. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.
properties.keyVault	KeyVaultContractProperties	Locatiedetails van KeyVault 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

Object

Details van certificaat maken of bijwerken.

Name	Type	Description
properties.data	string	Base 64 gecodeerd certificaat met behulp van de toepassing/x-pkcs12-weergave.
properties.keyVault	KeyVaultContractCreateProperties	Locatiedetails van KeyVault van het certificaat.
properties.password	string	Wachtwoord voor het certificaat

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

KeyVaultContractCreateProperties

Object

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 een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi

KeyVaultContractProperties

Object

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 keer synchroniseren en de status van geheim vernieuwen vanuit de sleutelkluis.
secretIdentifier	string	Sleutelkluisgeheim-id voor het ophalen van een geheim. Als u een versiegeheim oplevert, wordt automatisch vernieuwen voorkomen. Hiervoor moet de API Management-service worden geconfigureerd met aka.ms/apimmsi

KeyVaultLastAccessStatusContractProperties

Object

Probleem met update-eigenschappen van contract.

Name	Type	Description
code	string	Laatste statuscode voor synchronisatie en vernieuwing van geheim uit sleutelkluis.
message	string	Details van de fout leeg.
timeStampUtc	string (date-time)	Laatste keer dat het geheim werd geopend. De datum voldoet aan de volgende indeling: `yyyy-MM-ddTHH:mm:ssZ` zoals opgegeven door de ISO 8601-standaard.

Delen via

Workspace Certificate - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementCreateWorkspaceCertificate

Voorbeeldaanvraag

Voorbeeldrespons

ApiManagementCreateWorkspaceCertificateWithKeyVault

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CertificateContract

CertificateCreateOrUpdateParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

Aanvullende resources