ApiRelease interface
Rozhraní představující ApiRelease
Metody
| create |
Vytvoří novou verzi pro rozhraní API. |
| delete(string, string, string, string, string, Api |
Odstraní zadanou verzi v rozhraní API. |
| get(string, string, string, string, Api |
Vrátí podrobnosti verze rozhraní API. |
| get |
Vrátí etag vydané verze rozhraní API. |
| list |
Zobrazí seznam všech verzí rozhraní API. Při vytváření revize rozhraní API se vytvoří verze rozhraní API. Vydané verze se také používají k vrácení zpět na předchozí revize. Výsledky budou stránkovány a mohou být omezené parametry $top a $skip. |
| update(string, string, string, string, string, Api |
Aktualizuje podrobnosti o vydání rozhraní API určeného jeho identifikátorem. |
Podrobnosti metody
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Vytvoří novou verzi pro rozhraní API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API V aktuální instanci služby API Management musí být jedinečné.
- parameters
- ApiReleaseContract
Vytvořte parametry.
Parametry možností.
Návraty
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Odstraní zadanou verzi v rozhraní API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API V aktuální instanci služby API Management musí být jedinečné.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- options
- ApiReleaseDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Vrátí podrobnosti verze rozhraní API.
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API V aktuální instanci služby API Management musí být jedinečné.
- options
- ApiReleaseGetOptionalParams
Parametry možností.
Návraty
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Vrátí etag vydané verze rozhraní API.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API V aktuální instanci služby API Management musí být jedinečné.
Parametry možností.
Návraty
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
Zobrazí seznam všech verzí rozhraní API. Při vytváření revize rozhraní API se vytvoří verze rozhraní API. Vydané verze se také používají k vrácení zpět na předchozí revize. Výsledky budou stránkovány a mohou být omezené parametry $top a $skip.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
Parametry možností.
Návraty
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Aktualizuje podrobnosti o vydání rozhraní API určeného jeho identifikátorem.
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
- serviceName
-
string
Název služby API Management.
- apiId
-
string
Identifikátor rozhraní API. V aktuální instanci služby API Management musí být jedinečné.
- releaseId
-
string
Identifikátor verze v rámci rozhraní API V aktuální instanci služby API Management musí být jedinečné.
- ifMatch
-
string
ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.
- parameters
- ApiReleaseContract
Parametry aktualizace vydané verze rozhraní API
- options
- ApiReleaseUpdateOptionalParams
Parametry možností.
Návraty
Promise<ApiReleaseUpdateResponse>