Udostępnij przez

az apic integration create

Note

Ta dokumentacja jest częścią rozszerzenia apic-extension dla interfejsu wiersza polecenia platformy Azure (wersja 2.57.0 lub nowsza). Rozszerzenie zostanie automatycznie zainstalowane przy pierwszym uruchomieniu polecenia az apic integration create. Dowiedz się więcej o rozszerzeniach.

Polecenia

Nazwa Opis Typ Stan
az apic integration create apim

Dodaj usługę Azure APIM jako źródło interfejsu API.

 Extension ogólna dostępność
az apic integration create aws

Dodaj usługę Amazon API Gateway jako źródło interfejsu API.

 Extension ogólna dostępność

az apic integration create apim

Dodaj usługę Azure APIM jako źródło interfejsu API.

az apic integration create apim --azure-apim
                                --integration-name
                                --resource-group
                                --service-name
                                [--import-specification {always, never, ondemand}]
                                [--msi-resource-id]
                                [--target-environment-id]
                                [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Przykłady

Dodawanie usługi Azure APIM w tej samej grupie zasobów co wystąpienie centrum interfejsu API platformy Azure jako źródło interfejsu API

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim myapim

Dodawanie usługi Azure APIM w innej grupie zasobów jako źródła interfejsu API

az apic integration create apim -g contoso-resources -n contoso -i sync-from-my-apim --azure-apim /subscriptions/12345678-1234-1234-1234-123456789abc/resourceGroups/samplegroup/providers/Microsoft.ApiManagement/service/sampleapim

Parametry wymagane

--azure-apim

Nazwa lub identyfikator zasobu źródłowego wystąpienia usługi APIM.

Właściwość Wartość
Grupa parametrów: AzureApiManagementSource Arguments
--integration-name -i

Nazwa integracji.

--resource-group -g

Nazwa grupy zasobów centrum interfejsów API platformy Azure. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa usługi Azure API Center.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--import-specification

Wskazuje, czy specyfikację należy zaimportować wraz z metadanymi.

Właściwość Wartość
Grupa parametrów: Properties Arguments
Domyślna wartość: always
Dopuszczalne wartości: always, never, ondemand
--msi-resource-id

Identyfikator zasobu tożsamości zarządzanej, która ma dostęp do wystąpienia usługi API Management.

Właściwość Wartość
Grupa parametrów: AzureApiManagementSource Arguments
--target-environment-id

Identyfikator zasobu środowiska docelowego.

Właściwość Wartość
Grupa parametrów: Properties Arguments
--target-lifecycle-stage

Docelowy etap cyklu życia.

Właściwość Wartość
Grupa parametrów: Properties Arguments
Dopuszczalne wartości: deprecated, design, development, preview, production, retired, testing
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False

az apic integration create aws

Dodaj usługę Amazon API Gateway jako źródło interfejsu API.

az apic integration create aws --aws-access-key-reference
                               --aws-region-name
                               --aws-secret-access-key-reference
                               --integration-name
                               --resource-group
                               --service-name
                               [--import-specification {always, never, ondemand}]
                               [--msi-resource-id]
                               [--target-environment-id]
                               [--target-lifecycle-stage {deprecated, design, development, preview, production, retired, testing}]

Przykłady

Dodawanie usługi Amazon API Gateway jako źródła interfejsu API

az apic integration create aws -g contoso-resources -n contoso -i sync-from-my-amazon-api-gateway -a https://{keyvaultName}.vault.azure.net/secrets/{secretName1} -s https://{keyvaultName}.vault.azure.net/secrets/{secretName2} -r us-east-2

Parametry wymagane

--aws-access-key-reference -a

Klucz dostępu usługi Amazon API Gateway. Musi być odwołaniem do wpisu tajnego usługi Azure Key Vault.

Właściwość Wartość
Grupa parametrów: AmazonApiGatewaySource Arguments
--aws-region-name -r

Region usługi Amazon API Gateway (np. us-east-2).

Właściwość Wartość
Grupa parametrów: AmazonApiGatewaySource Arguments
--aws-secret-access-key-reference -s

Klucz dostępu tajnego usługi Amazon API Gateway. Musi być odwołaniem do wpisu tajnego usługi Azure Key Vault.

Właściwość Wartość
Grupa parametrów: AmazonApiGatewaySource Arguments
--integration-name -i

Nazwa integracji.

--resource-group -g

Nazwa grupy zasobów centrum interfejsów API platformy Azure. Grupę domyślną można skonfigurować przy użyciu az configure --defaults group=<name>.

--service-name -n

Nazwa usługi Azure API Center.

Parametry opcjonalne

Poniższe parametry są opcjonalne, ale w zależności od kontekstu co najmniej jeden może być wymagany do pomyślnego wykonania polecenia.

--import-specification

Wskazuje, czy specyfikację należy zaimportować wraz z metadanymi.

Właściwość Wartość
Grupa parametrów: Properties Arguments
Domyślna wartość: always
Dopuszczalne wartości: always, never, ondemand
--msi-resource-id

Identyfikator zasobu tożsamości zarządzanej, która ma dostęp do usługi Azure Key Vault.

Właściwość Wartość
Grupa parametrów: AmazonApiGatewaySource Arguments
--target-environment-id

Identyfikator zasobu środowiska docelowego.

Właściwość Wartość
Grupa parametrów: Properties Arguments
--target-lifecycle-stage

Docelowy etap cyklu życia.

Właściwość Wartość
Grupa parametrów: Properties Arguments
Dopuszczalne wartości: deprecated, design, development, preview, production, retired, testing
Parametry globalne
--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False
--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

Właściwość Wartość
Domyślna wartość: False
--output -o

Format danych wyjściowych.

Właściwość Wartość
Domyślna wartość: json
Dopuszczalne wartości: json, jsonc, none, table, tsv, yaml, yamlc
--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Subskrypcję domyślną można skonfigurować przy użyciu az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj --debuguj, aby uzyskać pełne dzienniki debugowania.

Właściwość Wartość
Domyślna wartość: False