Udostępnij za pośrednictwem


Microsoft.ApiManagement — usługa/certyfikaty

Definicja zasobu Bicep

Typ zasobu usługi/certyfikatów można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/certificates, dodaj następujący element Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/certificates@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    data: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    password: 'string'
  }
}

Wartości właściwości

usługa/certyfikaty

Nazwa Opis Wartość
nazwa Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w Bicep.
ciąg (wymagany)

Limit znaków: 1–80

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery i kończy się znakiem alfanumerycznym.
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.
Nazwa symboliczna zasobu typu: usługi
Właściwości Szczegóły właściwości tworzenia lub aktualizowania certyfikatu. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nazwa Opis Wartość
dane Certyfikat zakodowany w formacie Base 64 przy użyciu reprezentacji application/x-pkcs12. struna
keyVault Szczegóły lokalizacji usługi KeyVault certyfikatu. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
hasło Hasło certyfikatu struna

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nazwa Opis Wartość
identityClientId Wartość null dla elementu SystemAssignedIdentity lub Identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. struna
secretIdentifier Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych przy użyciu szablonu

wdrażanie w usłudze Azure
Ten szablon przedstawia sposób tworzenia usługi API Management i konfigurowania jednostek podrzędnych

Definicja zasobu szablonu usługi ARM

Typ zasobu usługi/certyfikatów można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/certificates, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ApiManagement/service/certificates",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "data": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "password": "string"
  }
}

Wartości właściwości

usługa/certyfikaty

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.ApiManagement/service/certificates"
apiVersion Wersja interfejsu API zasobów "2023-09-01-preview"
nazwa Nazwa zasobu

Zobacz, jak ustawiać nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM JSON.
ciąg (wymagany)

Limit znaków: 1–80

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery i kończy się znakiem alfanumerycznym.
Właściwości Szczegóły właściwości tworzenia lub aktualizowania certyfikatu. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nazwa Opis Wartość
dane Certyfikat zakodowany w formacie Base 64 przy użyciu reprezentacji application/x-pkcs12. struna
keyVault Szczegóły lokalizacji usługi KeyVault certyfikatu. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
hasło Hasło certyfikatu struna

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nazwa Opis Wartość
identityClientId Wartość null dla elementu SystemAssignedIdentity lub Identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. struna
secretIdentifier Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi struna

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon Opis
Tworzenie wystąpienia usługi API Management i wszystkich zasobów podrzędnych przy użyciu szablonu

wdrażanie w usłudze Azure
Ten szablon przedstawia sposób tworzenia usługi API Management i konfigurowania jednostek podrzędnych

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu usługi/certyfikatów można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/certificates, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/certificates@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      data = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      password = "string"
    }
  })
}

Wartości właściwości

usługa/certyfikaty

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.ApiManagement/service/certificates@2023-09-01-preview"
nazwa Nazwa zasobu ciąg (wymagany)

Limit znaków: 1–80

Prawidłowe znaki:
Alfanumeryczne i łączniki.

Zacznij od litery i kończy się znakiem alfanumerycznym.
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Szczegóły właściwości tworzenia lub aktualizowania certyfikatu. CertificateCreateOrUpdatePropertiesOrCertificateCont...

CertificateCreateOrUpdatePropertiesOrCertificateCont...

Nazwa Opis Wartość
dane Certyfikat zakodowany w formacie Base 64 przy użyciu reprezentacji application/x-pkcs12. struna
keyVault Szczegóły lokalizacji usługi KeyVault certyfikatu. KeyVaultContractCreatePropertiesOrKeyVaultContractPr...
hasło Hasło certyfikatu struna

KeyVaultContractCreatePropertiesOrKeyVaultContractPr...

Nazwa Opis Wartość
identityClientId Wartość null dla elementu SystemAssignedIdentity lub Identyfikator klienta userAssignedIdentity, który będzie używany do uzyskiwania dostępu do wpisu tajnego magazynu kluczy. struna
secretIdentifier Identyfikator wpisu tajnego magazynu kluczy do pobierania wpisu tajnego. Podanie wersji wpisu tajnego uniemożliwi automatyczne odświeżanie. Wymaga to skonfigurowania usługi API Management przy użyciu aka.ms/apimmsi struna