Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

azure-http-specs, add ARM CheckNameAvailability operations case #1934

Merged
merged 11 commits into from
Dec 25, 2024
+173 −0
Merged

azure-http-specs, add ARM CheckNameAvailability operations case #1934

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3cfe8b5
azure-http-specs, add ARM CheckNameAvailability operations case
v-hongli1 Nov 29, 2024
8ac2ec7
changelog
v-hongli1 Nov 29, 2024
78eb870
fix fromat
v-hongli1 Nov 29, 2024
62f404b
Merge branch 'main' into specs_arm_CheckNameAvailability_operations
v-hongli1 Nov 29, 2024
b4db2e1
Merge branch 'main' into specs_arm_CheckNameAvailability_operations
v-hongli1 Nov 29, 2024
9bd38c7
Merge branch 'main' into specs_arm_CheckNameAvailability_operations
v-hongli1 Dec 3, 2024
55cf3fc
Merge branch 'main' into specs_arm_CheckNameAvailability_operations
v-hongli1 Dec 3, 2024
f757736
Merge branch 'main' into specs_arm_CheckNameAvailability_operations
v-hongli1 Dec 23, 2024
d70464f
Fix comments
v-hongli1 Dec 23, 2024
1402d79
fix format
v-hongli1 Dec 24, 2024
a2103e4
fix comments
v-hongli1 Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .chronus/changes/specs_arm_CheckNameAvailability_operations-2024-10-29-17-11-41.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: feature
packages:
- "@azure-tools/azure-http-specs"
---

Added CheckNameAvailability operations case for ARM tests.
52 changes: 52 additions & 0 deletions packages/azure-http-specs/spec-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,58 @@ Expected response body:
}
```

### Azure_ResourceManager_OperationTemplates_CheckNameAvailability_checkGlobal

- Endpoint: `post https://management.azure.com`

Resource POST operation.
Expected path: /subscriptions/00000000-0000-0000-0000-000000000000/providers/Azure.ResourceManager.OperationTemplates/checkNameAvailability
Expected query parameter: api-version=2023-12-01-preview
Expected request body:

```json
{
"name": "checkName",
"type": "Microsoft.Web/site"
}
```

Expected response body:

```json
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "Hostname 'checkName' already exists. Please select a different name."
}
```

### Azure_ResourceManager_OperationTemplates_CheckNameAvailability_checkLocal

- Endpoint: `post https://management.azure.com`

Resource POST operation.
Expected path: /subscriptions/00000000-0000-0000-0000-000000000000/providers/Azure.ResourceManager.OperationTemplates/locations/westus/checkNameAvailability
Expected query parameter: api-version=2023-12-01-preview
Expected request body:

```json
{
"name": "checkName",
"type": "Microsoft.Web/site"
}
```

Expected response body:

```json
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "Hostname 'checkName' already exists. Please select a different name."
}
```

### Azure_ResourceManager_OperationTemplates_Lro_createOrReplace

- Endpoint: `put https://management.azure.com`
Expand Down
62 changes: 62 additions & 0 deletions ...re-http-specs/specs/azure/resource-manager/operation-templates/checkname-availability.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import "@typespec/http";
import "@typespec/rest";
import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-azure-resource-manager";
import "@typespec/spector";

using TypeSpec.Http;
using TypeSpec.Rest;
using Azure.Core;
using Azure.ResourceManager;
using TypeSpec.OpenAPI;
using Spector;

namespace Azure.ResourceManager.OperationTemplates;

interface CheckNameAvailability {
@scenario
@scenarioDoc("""
Resource POST operation.
Expected path: /subscriptions/00000000-0000-0000-0000-000000000000/providers/Azure.ResourceManager.OperationTemplates/checkNameAvailability
Expected query parameter: api-version=2023-12-01-preview
Expected request body:
```json
{
"name": "checkName",
"type": "Microsoft.Web/site"
}
```
Expected response body:
```json
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "Hostname 'checkName' already exists. Please select a different name."
}
```
""")
checkGlobal is checkGlobalNameAvailability;

@scenario
@scenarioDoc("""
Resource POST operation.
Expected path: /subscriptions/00000000-0000-0000-0000-000000000000/providers/Azure.ResourceManager.OperationTemplates/locations/westus/checkNameAvailability
Expected query parameter: api-version=2023-12-01-preview
Expected request body:
```json
{
"name": "checkName",
"type": "Microsoft.Web/site",
}
```
Expected response body:
```json
{
"nameAvailable": false,
"reason": "AlreadyExists",
"message": "Hostname 'checkName' already exists. Please select a different name."
}
```
""")
checkLocal is checkLocalNameAvailability;
}
1 change: 1 addition & 0 deletions packages/azure-http-specs/specs/azure/resource-manager/operation-templates/main.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import "@typespec/versioning";
import "@azure-tools/typespec-azure-core";
import "@azure-tools/typespec-azure-resource-manager";
import "@azure-tools/typespec-client-generator-core";
import "./checkname-availability.tsp";
import "./lro.tsp";

using TypeSpec.Http;
Expand Down
51 changes: 51 additions & 0 deletions packages/azure-http-specs/specs/azure/resource-manager/operation-templates/mockapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,61 @@ const validOrder = {
lastModifiedByType: "User",
},
};
const validCheckNameAvailability = {
v-hongli1 marked this conversation as resolved.
Show resolved Hide resolved
nameAvailable: false,
reason: "AlreadyExists",
message: "Hostname 'checkName' already exists. Please select a different name.",
};
let createOrReplacePollCount = 0;
let postPollCount = 0;
let deletePollCount = 0;

// Check Global Name Availability
Scenarios.Azure_ResourceManager_OperationTemplates_CheckNameAvailability_checkGlobal =
passOnSuccess({
uri: "/subscriptions/:subscriptionId/providers/Azure.ResourceManager.OperationTemplates/checkNameAvailability",
method: "post",
request: {
params: {
subscriptionId: SUBSCRIPTION_ID_EXPECTED,
"api-version": "2023-12-01-preview",
},
body: {
name: "checkName",
type: "Microsoft.Web/site",
},
},
response: {
status: 200,
body: json(validCheckNameAvailability),
},
kind: "MockApiDefinition",
});

// Check Local Name Availability
Scenarios.Azure_ResourceManager_OperationTemplates_CheckNameAvailability_checkLocal = passOnSuccess(
{
uri: "/subscriptions/:subscriptionId/providers/Azure.ResourceManager.OperationTemplates/locations/:location/checkNameAvailability",
method: "post",
request: {
params: {
subscriptionId: SUBSCRIPTION_ID_EXPECTED,
location: "westus",
"api-version": "2023-12-01-preview",
},
body: {
name: "checkName",
type: "Microsoft.Web/site",
},
},
response: {
status: 200,
body: json(validCheckNameAvailability),
},
kind: "MockApiDefinition",
},
);

// lro resource
Scenarios.Azure_ResourceManager_OperationTemplates_Lro_createOrReplace = passOnSuccess([
{
Expand Down
Loading