az apim

參考

管理 Azure API 管理服務。

命令

名稱	Description	類型	狀態
az apim api	管理 Azure API 管理 API。	核心	GA
az apim api create	建立 API 管理 API。	核心	GA
az apim api delete	刪除 API 管理 API。	核心	GA
az apim api export	匯出 API 管理 API。	核心	GA
az apim api import	匯入 API 管理 API。	核心	GA
az apim api list	列出 API 管理 API。	核心	GA
az apim api operation	管理 Azure API 管理 API 作業。	核心	GA
az apim api operation create	在 API 中建立新的作業。	核心	GA
az apim api operation delete	刪除 API 中指定的作業。	核心	GA
az apim api operation list	列出指定 API 之作業的集合。	核心	GA
az apim api operation show	取得其識別碼所指定的 API 作業詳細數據。	核心	GA
az apim api operation update	更新其識別碼所指定 API 中作業的詳細數據。	核心	GA
az apim api release	管理 Azure API 管理 API 版本。	核心	GA
az apim api release create	建立 API 的新版本。	核心	GA
az apim api release delete	刪除 API 中指定的版本。	核心	GA
az apim api release list	列出 API 的所有版本。	核心	GA
az apim api release show	傳回 API 版本的詳細數據。	核心	GA
az apim api release update	更新其識別碼所指定 API 版本的詳細數據。	核心	GA
az apim api revision	管理 Azure API 管理 API 修訂。	核心	GA
az apim api revision create	建立 API 修訂。	核心	GA
az apim api revision list	列出 API 的所有修訂。	核心	GA
az apim api schema	管理 Azure API 管理 API 架構。	核心	GA
az apim api schema create	建立 API 管理 API 架構。	核心	GA
az apim api schema delete	刪除 API 管理 API 架構。	核心	GA
az apim api schema get-etag	取得 API 管理 API 架構的 etag。	核心	GA
az apim api schema list	列出 API 架構 API 管理。	核心	GA
az apim api schema show	顯示 API 管理 API 架構的詳細數據。	核心	GA
az apim api schema wait	將 CLI 置於等候狀態，直到符合 apim API 架構的條件為止。	核心	GA
az apim api show	顯示 API 管理 API 的詳細數據。	核心	GA
az apim api update	更新 API 管理 API。	核心	GA
az apim api versionset	管理 Azure API 管理 API 版本集。	核心	GA
az apim api versionset create	建立 Api 版本集。	核心	GA
az apim api versionset delete	刪除特定的 Api 版本集。	核心	GA
az apim api versionset list	列出指定服務實例中的 API 版本集合。	核心	GA
az apim api versionset show	取得其標識碼所指定的 Api 版本集合詳細數據。	核心	GA
az apim api versionset update	更新其識別碼所指定的 Api VersionSet 詳細數據。	核心	GA
az apim api wait	將 CLI 置於等候狀態，直到符合 apim API 的條件為止。	核心	GA
az apim apply-network-updates	更新虛擬網路中執行的 API 管理資源，以挑選更新的網路設定。	核心	GA
az apim backup	建立 API 管理服務的備份至指定的 Azure 儲存體帳戶。這是長時間執行的作業，可能需要幾分鐘的時間才能完成。	核心	GA
az apim check-name	檢查服務名稱是否可供使用。	核心	GA
az apim create	建立 API 管理服務實例。	核心	GA
az apim delete	刪除 API 管理服務。	核心	GA
az apim deletedservice	管理虛刪除的 Azure API 管理服務。	核心	GA
az apim deletedservice list	列出指定訂用帳戶可供取消刪除的所有虛刪除 Api 管理服務實例。	核心	GA
az apim deletedservice purge	清除虛刪除的 Api 管理服務實例（刪除它且沒有取消刪除的選項）。	核心	GA
az apim deletedservice show	取得可依名稱取消刪除的虛刪除 Api 管理服務實例。	核心	GA
az apim graphql	管理 Azure API 管理 GraphQL API。	核心	GA
az apim graphql resolver	管理 Azure API 管理 GraphQL API 的解析程式。	核心	GA
az apim graphql resolver create	在 GraphQL API 中建立新的解析程式，或更新現有的解析程式。	核心	GA
az apim graphql resolver delete	刪除 GraphQL API 中指定的解析程式。	核心	GA
az apim graphql resolver list	列出指定之 GraphQL API 的解析程式集合。	核心	GA
az apim graphql resolver policy	管理 Azure API 管理 GraphQL API 的解析程序原則。	核心	GA
az apim graphql resolver policy create	建立或更新 GraphQL API 解析程式層級的原則設定。	核心	GA
az apim graphql resolver policy delete	刪除 GraphQL Api 解析程式的原則組態。	核心	GA
az apim graphql resolver policy list	取得 GraphQL API 解析程式層級的原則設定清單。	核心	GA
az apim graphql resolver policy show	取得 GraphQL API 解析程式層級的原則設定。	核心	GA
az apim graphql resolver show	取得其識別碼所指定的 GraphQL API 解析程式詳細數據。	核心	GA
az apim list	列出 API 管理服務實例。	核心	GA
az apim nv	管理 Azure API 管理具名值。	核心	GA
az apim nv create	建立 API 管理具名值。	核心	GA
az apim nv delete	刪除 API 管理具名值。	核心	GA
az apim nv list	列出 API 管理具名值。	核心	GA
az apim nv show	顯示 API 管理具名值的詳細數據。	核心	GA
az apim nv show-secret	取得 API 管理具名值的秘密。	核心	GA
az apim nv update	更新 API 管理具名值。	核心	GA
az apim nv wait	將 CLI 置於等候狀態，直到符合名為 value 的 apim 條件為止。	核心	GA
az apim product	管理 Azure API 管理產品。	核心	GA
az apim product api	管理 Azure API 管理產品的 API。	核心	GA
az apim product api add	將 API 新增至指定的產品。	核心	GA
az apim product api check	檢查標識子所指定的 API 實體是否與 Product 實體相關聯。	核心	GA
az apim product api delete	從指定的產品中刪除指定的 API。	核心	GA
az apim product api list	列出與產品相關聯的 API 集合。	核心	GA
az apim product create	建立產品。	核心	GA
az apim product delete	刪除產品。	核心	GA
az apim product list	列出指定服務實例中的產品集合。	核心	GA
az apim product show	取得其識別碼所指定產品的詳細數據。	核心	GA
az apim product update	更新現有的產品詳細數據。	核心	GA
az apim product wait	將 CLI 置於等候狀態，直到符合 apim 產品的條件為止。	核心	GA
az apim restore	還原使用目前服務上ApiManagementService_Backup作業所建立之 API 管理服務的備份。這是長時間執行的作業，可能需要幾分鐘的時間才能完成。	核心	GA
az apim show	顯示 API 管理服務實例的詳細數據。	核心	GA
az apim update	更新 API 管理服務實例。	核心	GA
az apim wait	將 CLI 置於等候狀態，直到符合 apim 的條件為止。	核心	GA

az apim apply-network-updates

編輯

更新虛擬網路中執行的 API 管理資源，以挑選更新的網路設定。

az apim apply-network-updates --name
                              --resource-group
                              [--location]
                              [--no-wait]

範例

更新 API 管理服務實例的虛擬網路設定

az apim apply-network-updates --name MyApim -g MyResourceGroup

必要參數

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--location -l

位置。來自的值： az account list-locations。您可以使用 az configure --defaults location=<location> 設定預設位置。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim backup

編輯

建立 API 管理服務的備份至指定的 Azure 儲存體帳戶。這是長時間執行的作業，可能需要幾分鐘的時間才能完成。

az apim backup --backup-name
               --container-name
               --name
               --resource-group
               --storage-account-key
               --storage-account-name
               [--no-wait]

範例

建立 API 管理服務實例的備份

az apim backup --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

必要參數

--backup-name

要建立的備份文件名稱。

--container-name --storage-account-container

用來放置備份的記憶體帳戶容器名稱。

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--storage-account-key

用來放置備份之記憶體帳戶的存取金鑰。

--storage-account-name

用來放置備份的記憶體帳戶名稱。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim check-name

編輯

檢查服務名稱是否可供使用。

az apim check-name --name

必要參數

--name -n

API 管理服務實例的名稱。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim create

編輯

建立 API 管理服務實例。

az apim create --name
               --publisher-email
               --publisher-name
               --resource-group
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--location]
               [--no-wait]
               [--public-network-access {false, true}]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

範例

建立開發人員層 API 管理服務。

az apim create --name MyApim -g MyResourceGroup -l eastus --publisher-email email@mydomain.com --publisher-name Microsoft

建立取用層 API 管理服務。

az apim create --name MyApim -g MyResourceGroup -l eastus --sku-name Consumption --enable-client-certificate \
    --publisher-email email@mydomain.com --publisher-name Microsoft

必要參數

--name -n

要建立之服務實例的唯一名稱。

名稱必須是全域唯一的，因為它會包含為閘道主機名，例如' https://my-api-servicename.azure-api.net'。請參閱範例。

--publisher-email

要接收所有系統通知的電子郵件位址。

--publisher-name

貴組織的名稱，以用於開發人員入口網站和電子郵件通知。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--disable-gateway

停用主要區域中的閘道。僅適用於部署在多個位置的 Api 管理服務。

接受的值: false, true

--enable-client-certificate

對閘道的每個要求強制執行要呈現的客戶端憑證，也可讓您在閘道的原則中驗證憑證。

接受的值: false, true

--enable-managed-identity

為 API 管理服務建立受控識別，以存取其他 Azure 資源。僅供取用 SKU 服務使用。

接受的值: false, true

預設值: False

--location -l

位置。來自的值： az account list-locations。您可以使用 az configure --defaults location=<location> 設定預設位置。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--public-network-access

此 API 管理服務是否允許公用端點存取。如果設定為 true，私人端點就是獨佔存取方法。

接受的值: false, true

--sku-capacity

SKU 的部署單位數目。

預設值: 1

--sku-name

API 管理實例的 SKU。

接受的值: Basic, Consumption, Developer, Isolated, Premium, Standard

預設值: Developer

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--virtual-network -v

虛擬網路類型。

接受的值: External, Internal, None

預設值: None

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim delete

編輯

刪除 API 管理服務。

az apim delete --name
               --resource-group
               [--no-wait]
               [--yes]

範例

刪除 API 管理服務。

az apim delete -n MyApim -g MyResourceGroup

必要參數

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--yes -y

不提示確認。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim list

編輯

列出 API 管理服務實例。

az apim list [--resource-group]

選擇性參數

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim restore

編輯

還原使用目前服務上ApiManagementService_Backup作業所建立之 API 管理服務的備份。這是長時間執行的作業，可能需要幾分鐘的時間才能完成。

az apim restore --backup-name
                --container-name
                --name
                --resource-group
                --storage-account-key
                --storage-account-name
                [--no-wait]

範例

還原 API 管理服務實例的備份

az apim restore --name MyApim -g MyResourceGroup --backup-name myBackup              --storage-account-name mystorageaccount --storage-account-container backups              --storage-account-key Ay2ZbdxLnD4OJPT29F6jLPkB6KynOzx85YCObhrw==

必要參數

--backup-name

要還原的備份檔名稱。

--container-name --storage-account-container

用來從中擷取備份的記憶體帳戶容器名稱。

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

--storage-account-key

用來從中擷取備份之記憶體帳戶的存取密鑰。

--storage-account-name

用來從中擷取備份的記憶體帳戶名稱。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim show

編輯

顯示 API 管理服務實例的詳細數據。

az apim show --name
             --resource-group

必要參數

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim update

編輯

更新 API 管理服務實例。

az apim update --name
               --resource-group
               [--add]
               [--disable-gateway {false, true}]
               [--enable-client-certificate {false, true}]
               [--enable-managed-identity {false, true}]
               [--force-string]
               [--no-wait]
               [--public-network-access {false, true}]
               [--publisher-email]
               [--publisher-name]
               [--remove]
               [--set]
               [--sku-capacity]
               [--sku-name {Basic, Consumption, Developer, Isolated, Premium, Standard}]
               [--tags]
               [--virtual-network {External, Internal, None}]

必要參數

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例：--add property.listProperty <key=value, string or JSON string>。

預設值: []

--disable-gateway

停用主要區域中的閘道。僅適用於部署在多個位置的 Api 管理服務。

接受的值: false, true

--enable-client-certificate

對閘道的每個要求強制執行要呈現的客戶端憑證，也可讓您在閘道的原則中驗證憑證。

接受的值: false, true

--enable-managed-identity

為 API 管理服務建立受控識別，以存取其他 Azure 資源。僅供取用 SKU 服務使用。

接受的值: false, true

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

預設值: False

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--public-network-access

此 API 管理服務是否允許公用端點存取。如果設定為 true，私人端點就是獨佔存取方法。

接受的值: false, true

--publisher-email

要接收所有系統通知的電子郵件位址。

--publisher-name

貴組織的名稱，以用於開發人員入口網站和電子郵件通知。

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

預設值: []

--set

指定要設定的屬性路徑和值，以更新物件。範例：--set property1.property2=<value>。

預設值: []

--sku-capacity

SKU 的部署單位數目。

--sku-name

API 管理實例的 SKU。

接受的值: Basic, Consumption, Developer, Isolated, Premium, Standard

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

--virtual-network -v

虛擬網路類型。

接受的值: External, Internal, None

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

az apim wait

編輯

將 CLI 置於等候狀態，直到符合 apim 的條件為止。

az apim wait --name
             --resource-group
             [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--interval]
             [--timeout]
             [--updated]

範例

將 CLI 置於等候狀態，直到符合 apim 的條件為止。（自動產生）

az apim wait --created --name MyApim --resource-group MyResourceGroup

必要參數

--name -n

API 管理服務實例的名稱。

--resource-group -g

資源群組的名稱。您可以使用 az configure --defaults group=<name> 來設定預設群組。

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: False

全域參數

--debug

增加記錄詳細資訊，以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

預設值: json

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或識別碼。您可以使用來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。使用 --debug 來取得完整偵錯記錄。

共用方式為

az apim

命令

az apim apply-network-updates

範例

必要參數

選擇性參數

az apim backup

範例

必要參數

選擇性參數

az apim check-name

必要參數

az apim create

範例

必要參數

選擇性參數

az apim delete

範例

必要參數

選擇性參數

az apim list

選擇性參數

az apim restore

範例

必要參數

選擇性參數

az apim show

必要參數

az apim update

必要參數

選擇性參數

az apim wait

範例

必要參數

選擇性參數

其他資源