Skip to content

Commit

Permalink
BillingRP AssociatedTenants and BillingRequests (#22538)
Browse files Browse the repository at this point in the history 
* Baseline for 2023-04-01 from 2020-05-01

* Add package info in readme

* Fix filename reference

* Split billing.json into different resource files

* GA for associated tenants and permission requests

* Update with latest generated files

* Update with latest types.json file

* Incorporate PR comments for display name

* PR comments from 9/27

* Update with comments from 10/4

* Incoporate PR comments from 10/10

* Fix model validation

* Update with PR comments from 10/19/2023

---------

Co-authored-by: Braden Watkins <brwatkin@microsoft.com>
  • Loading branch information
@bradenwatkins
bradenwatkins and Braden Watkins authored Oct 24, 2023
1 parent b0b657c commit b0de48a
Show file tree
Hide file tree
Showing 19 changed files with 2,318 additions and 623 deletions.
375 changes: 375 additions & 0 deletions ...cation/billing/resource-manager/Microsoft.Billing/stable/2023-04-01/associatedTenant.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,375 @@
{
"swagger": "2.0",
"info": {
"title": "BillingManagementClient",
"description": "Documentation for Microsoft.Billing.",
"contact": {
"name": "Microsoft.Billing",
"url": "https://learn.microsoft.com/en-us/rest/api/billing/",
"email": "pacebpexphot@microsoft.com"
},
"version": "2023-04-01"
},
"paths": {
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants/{associatedTenantName}": {
"delete": {
"tags": [
"AssociatedTenant"
],
"description": "Deletes an associated tenant for a billing account.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_Delete",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"$ref": "./types.json#/parameters/associatedTenantName"
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"202": {
"description": "An operation accepted result that returns a 'Location' header that the client can poll to view the result of the operation.",
"headers": {
"Location": {
"type": "string"
},
"Retry-After": {
"type": "integer",
"format": "int32"
}
}
},
"204": {
"description": "No Content"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"AssociatedTenantsDelete": {
"$ref": "./examples/associatedTenantsDelete.json"
}
}
},
"get": {
"tags": [
"AssociatedTenant"
],
"description": "Gets an associated tenant by ID.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_Get",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"$ref": "./types.json#/parameters/associatedTenantName"
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
}
],
"responses": {
"200": {
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-examples": {
"AssociatedTenantsGet": {
"$ref": "./examples/associatedTenantsGet.json"
}
}
},
"put": {
"tags": [
"AssociatedTenant"
],
"description": "Create or update an associated tenant for the billing account.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_CreateOrUpdate",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"$ref": "./types.json#/parameters/associatedTenantName"
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
},
{
"in": "body",
"name": "body",
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
}
}
],
"responses": {
"200": {
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
}
},
"201": {
"description": "An associated tenant.",
"schema": {
"$ref": "#/definitions/AssociatedTenant"
},
"headers": {
"Location": {
"type": "string"
},
"Retry-After": {
"type": "integer",
"format": "int32"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-examples": {
"AssociatedTenantsCreateOrUpdate": {
"$ref": "./examples/associatedTenantsCreateOrUpdate.json"
}
}
}
},
"/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/associatedTenants": {
"get": {
"tags": [
"AssociatedTenant"
],
"description": "Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.",
"externalDocs": {
"url": "https://docs.microsoft.com/en-us/rest/api/billing/"
},
"operationId": "AssociatedTenants_ListByBillingAccount",
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "./types.json#/parameters/billingAccountName"
},
{
"in": "query",
"name": "includeRevoked",
"description": "Can be used to get revoked associated tenants.",
"type": "boolean",
"default": false
},
{
"$ref": "./types.json#/parameters/apiVersionParameter"
},
{
"$ref": "./types.json#/parameters/filter"
},
{
"$ref": "./types.json#/parameters/orderBy"
},
{
"$ref": "./types.json#/parameters/top"
},
{
"$ref": "./types.json#/parameters/skip"
},
{
"$ref": "./types.json#/parameters/count"
},
{
"$ref": "./types.json#/parameters/search"
}
],
"responses": {
"200": {
"description": "A list of associated tenants.",
"schema": {
"$ref": "#/definitions/AssociatedTenantListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./types.json#/definitions/ArmErrorResponse"
}
}
},
"x-ms-examples": {
"AssociatedTenantsListByBillingAccount": {
"$ref": "./examples/associatedTenantsListByBillingAccount.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"AssociatedTenant": {
"description": "An associated tenant.",
"type": "object",
"allOf": [
{
"$ref": "./types.json#/definitions/ArmResource"
}
],
"properties": {
"properties": {
"description": "The properties of a(n) AssociatedTenant",
"allOf": [
{
"$ref": "#/definitions/AssociatedTenantProperties"
}
],
"x-ms-client-flatten": true
}
},
"x-ms-azure-resource": true
},
"AssociatedTenantListResult": {
"description": "A container for a list of resources",
"type": "object",
"properties": {
"nextLink": {
"description": "The link (url) to the next page of results.",
"type": "string",
"readOnly": true
},
"value": {
"description": "The list of resources.",
"type": "array",
"items": {
"$ref": "#/definitions/AssociatedTenant"
},
"readOnly": true,
"x-ms-identifiers": [
"id"
]
}
}
},
"AssociatedTenantProperties": {
"description": "An associated tenant.",
"type": "object",
"properties": {
"displayName": {
"description": "The name of the associated tenant.",
"type": "string"
},
"tenantId": {
"description": "The ID that uniquely identifies a tenant.",
"type": "string"
},
"billingManagementState": {
"description": "The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases.",
"enum": [
"Other",
"NotAllowed",
"Active",
"Revoked"
],
"type": "string",
"x-ms-enum": {
"name": "BillingManagementTenantState",
"modelAsString": true
}
},
"provisioningManagementState": {
"description": "The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request.",
"enum": [
"Other",
"NotRequested",
"Active",
"Pending",
"BillingRequestExpired",
"BillingRequestDeclined",
"Revoked"
],
"type": "string",
"x-ms-enum": {
"name": "ProvisioningTenantState",
"modelAsString": true
}
},
"provisioningBillingRequestId": {
"description": "The unique identifier for the billing request that is created when enabling provisioning for an associated tenant.",
"type": "string",
"readOnly": true
}
}
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"description": "Azure Active Directory OAuth2 Flow."
}
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
]
}
Loading

0 comments on commit b0de48a

Please sign in to comment.