Set-AzApiManagementApiVersionSet
更新 API 管理 內容中的 API 版本集。
Syntax
Set-AzApiManagementApiVersionSet
-Context <PsApiManagementContext>
-ApiVersionSetId <String>
[-Name <String>]
[-Scheme <PsApiManagementVersioningScheme>]
[-HeaderName <String>]
[-QueryName <String>]
[-Description <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-AzApiManagementApiVersionSet
-InputObject <PsApiManagementApiVersionSet>
[-Name <String>]
[-Scheme <PsApiManagementVersioningScheme>]
[-HeaderName <String>]
[-QueryName <String>]
[-Description <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
Set-AzApiManagementApiVersionSet Cmdlet 會修改 Azure API 管理 API 版本集。
範例
範例 1
$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string"此命令會使用版本設定配置 Header 和標頭參數 api-version來更新現有的 API 版本集合。
參數
-ApiVersionSetId
新 API 版本集的識別碼。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Confirm
執行 Cmdlet 之前先提示您確認。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Context
PsApiManagementContext 的實例。 此為必要參數。
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Api 版本集的描述。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HeaderName
標頭值，其中包含版本設定資訊。 如果已選擇版本設定配置標頭，則必須指定此值。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InputObject
PsApiManagementApiVersionSet 的實例。 此為必要參數。
| Type: | PsApiManagementApiVersionSet |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
ApiVersion 集合的名稱。 這是選擇性參數。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PassThru
如果指定，則會將代表已修改 apiVersionSet 之 Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet 類型的實例寫入輸出。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-QueryName
查詢值，其中包含版本設定資訊。 如果已選擇版本設定配置查詢，則必須指定此值。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scheme
要針對 Api 版本設定集選取的版本設定設定。 這是選擇性參數。
| Type: | PsApiManagementVersioningScheme |
| Accepted values: | Segment, Query, Header |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
輸入
PsApiManagementVersioningScheme